DescribeDomainReqHitRateData

Last Updated: Apr 02, 2018

Description

  • Obtain the request hit rate (percentage of hit requests) of CDN domain names.

  • 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. 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 DescribeDomainReqHitRateData

The name of this interface. Value: DescribeDomainReqHitRateData

DomainName String No www.yourdomain.com

CDN domain to be queried. This parameter can be set to support only one domain name. If this parameter is left blank, the system queries all domain names.

EndTime String No 2017-12-22T08:00:00: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.

Interval String No 300

  • Time granularity of data query.
  • 300s, 3600s, 14400s, 28800s and 86400s are supported.
  • When the parameter is left blank or when the value is not supported, the default value 300 seconds is used.

StartTime String No 2017-12-21T08:00:00: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.

Return parameters

Parameters Type Example values Description
DomainName String test.com

CDN domain name information.

DataInterval String 300

Interval of each record. The unit is seconds.

StartTime String 2015-12-10T20:00Z

Start time.

EndTime String 2015-12-10T21:00Z

End time.

ReqHitRateInterval

Bytes hit rate during each interval.

  └TimeStamp String 2017-12-22T08:00:00:00Z

Start time of a time slice.

  └Value String 100.0

Detailed usage data.

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Example

Return example

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

Normal return example

JSON format

  1. {
  2. "DataInterval":"300",
  3. "DomainName":"test.com",
  4. "EndTime":"2015-12-10T21:00Z",
  5. "ReqHitRateInterval":{
  6. "DataModule":[
  7. {
  8. "TimeStamp":"2015-12-10T21:00:00Z",
  9. "Value":"100.0"
  10. },
  11. {
  12. "TimeStamp":"2015-12-10T20:35:00Z",
  13. "Value":"100.0"
  14. },
  15. {
  16. "TimeStamp":"2015-12-10T20:50:00Z",
  17. "Value":"99.99932881437826"
  18. },
  19. {
  20. "TimeStamp":"2015-12-10T20:05:00Z",
  21. "Value":"100.0"
  22. },
  23. {
  24. "TimeStamp":"2015-12-10T20:10:00Z",
  25. "Value":"100.0"
  26. },
  27. {
  28. "TimeStamp":"2015-12-10T20:55:00Z",
  29. "Value":"100.0"
  30. },
  31. {
  32. "TimeStamp":"2015-12-10T20:30:00Z",
  33. "Value":"100.0"
  34. },
  35. {
  36. "TimeStamp":"2015-12-10T20:25:00Z",
  37. "Value":"100.0"
  38. },
  39. {
  40. "TimeStamp":"2015-12-10T20:00:00Z",
  41. "Value":"100.0"
  42. },
  43. {
  44. "TimeStamp":"2015-12-10T20:40:00Z",
  45. "Value":"100.0"
  46. },
  47. {
  48. "TimeStamp":"2015-12-10T20:15:00Z",
  49. "Value":"100.0"
  50. },
  51. {
  52. "TimeStamp":"2015-12-10T20:45:00Z",
  53. "Value":"100.0"
  54. },
  55. {
  56. "TimeStamp":"2015-12-10T20:20:00Z",
  57. "Value":"100.0"
  58. }
  59. ]
  60. },
  61. "RequestId":"5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD",
  62. "StartTime":"2015-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.