edit-icon download-icon

DescribeLiveDomainBpsData

Last Updated: Jul 24, 2018

Description

Obtain the network bandwidth data of a live domain name. Unit:bit/second.

  • When StartTime and EndTime are not specified, the system reads data from the past 24 hours by default. Query by specified start time and end time is also supported. The two parameters must be both specified.

  • Batch domain name query is supported. Domain names are separated by commas (half width).

  • Data from the past 90 days can be obtained at most.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeLiveDomainBpsData

The name of this interface. Value: DescribeLiveDomainBpsData.

DomainName String No test.com

The live domain name to be queried.

  • If the parameter is left blank, the system returns the combined data of all the live domain names by default.
  • Batch domain names query is supported.
  • Domain names are seperated by commas (,) (half width).

StartTime String No 2017-12-10T20:00:00Z

Starttime of data query.

  • The date format adopts ISO8601 notation and uses the UTC time.
  • Format: YYYY-MM-DDThh:mm:ssZ.
  • The minimum granularity is 5 minutes.
  • The maximum granularity is 1 day.
  • Data within 45 days can be viewed.

EndTime String No 2017-12-10T21:00:00Z

Endtime of data query, required to be later than Starttime.

  • The date format adopts ISO8601 notation and uses the UTC time.
  • Format: YYYY-MM-DDThh:mm:ssZ.
  • The minimum granularity is 5 minutes.
  • The maximum granularity is 1 day.
  • Data within 45 days can be viewed.

Return parameters

Parameters Type Example values Description
DomainName String test.com

Live domain name.

DataInterval String 300

Time granularity for data query.

RequestId String B955107D-E658-4E77-B913-E0AC3D31693E

Request ID.

BpsDataPerInterval

Network bandwidth data in each time interval.

  └TimeStamp String 2017-12-10T20:00:05Z

Start time of a time slice.

  └BpsValue String 11288111

Bandwidth value.
Unit: bit/second (bps)

  └HttpBpsValue String 11286111

HTTP bandwidth value.
Unit: bit/second (bps)

  └HttpsBpsValue String 2000

HTTPS bandwidth value.
Unit: bit/second (bps)

StartTime String 2017-12-10T20:00:00Z

Start time.

EndTime String 2017-12-10T21:00:00Z

End time.

Example

Request example

  1. http://live.aliyuncs.com?Action=DescribeLiveDomainBpsData&DomainName=test.com
  2. &StartTime=2017-12-10T20:00:00Z
  3. &EndTime=2017-12-10T21:00:00Z
  4. &<Public request parameter>

Normal return example

JSON format

  1. {
  2. "BpsDataPerInterval":{
  3. "DataModule":[
  4. {
  5. "BpsValue":"11288111",
  6. "HttpBpsValue":"11286111",
  7. "HttpsBpsValue":"2000",
  8. "TimeStamp":"2017-12-10T20:00:00Z"
  9. },
  10. {
  11. "BpsValue":"1288111",
  12. "HttpBpsValue":"1286111",
  13. "HttpsBpsValue":"2000",
  14. "TimeStamp":"2017-12-10T20:05:00Z"
  15. }
  16. ]
  17. },
  18. "DataInterval":"300",
  19. "DomainName":"test.com",
  20. "EndTime":"2017-12-10T21:00:00Z",
  21. "RequestId":"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  22. "StartTime":"2017-12-10T20:00:00Z"
  23. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

Error code

For more information about error code of this product, see Error code.

Thank you! We've received your feedback.