DescribeDomainSrcBpsData

Last Updated: May 17, 2018

Description

  • Obtain the back-to-source bandwidth metric data of CDN domains. The unit is 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 (at most 200 domain names one time). Multiple 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 DescribeDomainSrcBpsData

The name of this interface. Value: DescribeDomainSrcData

DomainName String No www.yourdomain.com

  • If the parameter is left blank, the system returns the combined data of all CDN domains by default.
  • You can enter CDN domains to be queried.
  • Batch domain name query is supported. Multiple domain names are separated by commas (half width).

EndTime String No 2017-12-12T20:00Z

  • The end time must be later than the start time.
  • The date format adopts ISO8601 notation and uses the UTC time.
  • Format: YYYY-MM-DDThh:mmZ.

FixTimeGap String No false

Zero-padding is performed during download.

Interval String No 300

Time interval.

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

  • Start time of data query.
  • The date format adopts ISO8601 notation and uses the UTC time.
  • Format: YYYY-MM-DDThh:mmZ.
  • Minimum data granularity: 5 minutes.
  • If this parameter is unspecified, data from the past 24 hours is read by default.

TimeMerge String No on

Value range:

  • on: default value, indicating that the interval of each record can be merged based on the time span.
  • off: data of 5-min-granularity is returned, and the maximum time span is 31 days.

Version String No 2014-11-11

API version.

Return parameters

Parameters Type Exampel values Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

DomainName String yourdomain.com

Your CDN domain name information.

StartTime String 2017-12-10T20:00Z

Start time.

EndTime String 2017-12-12T20:00Z

End time.

DataInterval String 300

Interval of each record. The unit is seconds.

SrcBpsDataPerInterval

Back-to-source bandwidth data during each interval.

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

Start time of a time slice.

  └Value String 500

Detailed usage data.

Example

Request example

  1. http://cdn.aliyuncs.com?Action=DescribeDomainSrcBpsData&DomainName=test.com
  2. &StartTime=2017-12-10T20:00Z
  3. &EndTime=2017-12-10T21:00Z
  4. &<公public request parameters>

Normal return example

JSON format

  1. {
  2. "DataInterval":"300",
  3. "DomainName":"test.com",
  4. "EndTime":"2017-12-10T21:00Z",
  5. "RequestId":"7CBCD6AD-B016-42E5-AE0B-B3731DE8F755",
  6. "SrcBpsDataPerInterval":{
  7. "DataModule":[
  8. {
  9. "TimeStamp":"2015-12-10T21:00:00Z",
  10. "Value":"0"
  11. },
  12. {
  13. "TimeStamp":"2015-12-10T20:35:00Z",
  14. "Value":"0"
  15. },
  16. {
  17. "TimeStamp":"2015-12-10T20:50:00Z",
  18. "Value":"821"
  19. },
  20. {
  21. "TimeStamp":"2015-12-10T20:05:00Z",
  22. "Value":"0"
  23. },
  24. {
  25. "TimeStamp":"2015-12-10T20:10:00Z",
  26. "Value":"0"
  27. },
  28. {
  29. "TimeStamp":"2015-12-10T20:55:00Z",
  30. "Value":"0"
  31. },
  32. {
  33. "TimeStamp":"2015-12-10T20:30:00Z",
  34. "Value":"0"
  35. },
  36. {
  37. "TimeStamp":"2015-12-10T20:25:00Z",
  38. "Value":"0"
  39. },
  40. {
  41. "TimeStamp":"2015-12-10T20:00:00Z",
  42. "Value":"0"
  43. },
  44. {
  45. "TimeStamp":"2015-12-10T20:40:00Z",
  46. "Value":"0"
  47. },
  48. {
  49. "TimeStamp":"2015-12-10T20:15:00Z",
  50. "Value":"0"
  51. },
  52. {
  53. "TimeStamp":"2015-12-10T20:45:00Z",
  54. "Value":"0"
  55. },
  56. {
  57. "TimeStamp":"2015-12-10T20:20:00Z",
  58. "Value":"0"
  59. }
  60. ]
  61. },
  62. "StartTime":"2017-12-10T20:00Z"
  63. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"cdn.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
  6. }

Error code

For more information, see Error code of this product.

Thank you! We've received your feedback.