All Products
Search
Document Center

DescribeDcdnDomainHitRateData

Last Updated: May 17, 2019

Description

You can call this operation to obtain the cache hit ratio of a specified DCDN domain name.

If you do not specify the StartTime and EndTime, you obtain cache hit ratio of the last 24 hours by default. To obtain the cache hit ratio within a certain period, you must specify both the StartTime and the EndTime.

  • You can specify multiple domain names separated with commas (,).

  • You can obtain the cache hit ratio of the last 90 days at most.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform.
Set the value to DescribeDcdnDomainHitRateData.
DomainName String No The name of the DCDN domain that you want to query.
You can specify only one domain name. If you do not set the parameter, you obtain the cache hit ratio of all domain names by default.
StartTime String No The start time of the required data.
The date format follows the ISO8601 standard and uses UTC time.
Format: YYYY-MM-DDThh:mm:ssZ.
The minimum interval between the start time and the end time of the required data is 5 minutes.
If you do not specify the StartTime, you obtain the cache hit ratio of the last 24 hours by default.
EndTime String No The end time of the required data. The date format follows the ISO8601 standard and uses UTC time.
The end time must be later than the start time.
Format: YYYY-MM-DDThh:mm:ssZ.
Interval String No The interval between the start time and the end time of the required data. Unit: seconds. Valid values:
  • Less than 3 days: 300, 3600, and 86400.
  • 3 days-31 days (excluding 31 days): 3600 and 86400.
  • No less than 31 days: 86400
  • The default value is used if you do not specify the parameter or specify an invalid value.

Response parameters

Name Type Description
DomainName String The name of the specified DCDN domain.
DataInterval String The interval of each item. Unit: seconds.
StartTime DateTime The start time of the required data.
EndTime DateTime The end time of the required data.
HitRatePerInterval DataModule[] The cache hit ratio at the specified intervals.

DataModule

Name Type Description
TimeStamp String The start time of the specified time slice.
ByteHitRate Float The cache hit ratio of bytes.
ReqHitRate Float The cache hit ratio of requests.

Examples

Sample requests

  1. http://scdn.aliyuncs.com?Action=DescribeDcdnDomainHitRateData&DomainName=test.com
  2. &StartTime=2018-03-02T12:00:00Z
  3. &EndTime=2018-03-02T15:00:00Z
  4. &<Common request parameters>

Sample responses

JSON format

  1. {
  2. "DomainName": "test.com",
  3. "DataInterval": 3600,
  4. "HitRatePerInterval": {
  5. "DataModule": [
  6. {
  7. "ByteHitRate": 0,
  8. "TimeStamp": "2018-03-02T15:00:00Z",
  9. "ReqHitRate": 0
  10. },
  11. {
  12. "ByteHitRate": 0,
  13. "TimeStamp": "2018-03-02T14:00:00Z",
  14. "ReqHitRate": 0
  15. },
  16. {
  17. "ByteHitRate": 0,
  18. "TimeStamp": "2018-03-02T13:00:00Z",
  19. "ReqHitRate": 0
  20. },
  21. {
  22. "ByteHitRate": 0,
  23. "TimeStamp": "2018-03-02T12:00:00Z",
  24. "ReqHitRate": 0
  25. }
  26. ]
  27. },
  28. "RequestId": "4D07ABFE-4737-4834-B1B9-A661308C47B4",
  29. "EndTime": "2018-03-02T15:00:00Z",
  30. "StartTime": "2018-03-02T12:00:00Z"
  31. }

Error codes

Error code Error message HTTP status code Description
Throttling Request was denied due to request throttling. 503 The error message returned when the request was denied due to throttling.
IllegalOperation Illegal domain, operation is not permitted. 403 The error message returned when the domain name is invalid.
OperationDenied Your account does not open CDN service yet. 403 The error message returned when the CDN service is not activated.
OperationDenied Your CDN service is suspended. 403 The error message returned when your CDN service is suspended.
InvalidDomain.NotFound The domain provided does not belong to you. 404 The error message returned when the domain name does not exist or does not belong to you.
InvalidDomain.Offline The domain provided is offline. 404 The error message returned when the domain is offline.
ServiceBusy The specified Domain is configuring, please retry later. 403 The error message returned when the domain name is being configured. Try again later.
InvalidDomain.Configure_failed Failed to configure the provided domain. 500 The error message returned when you failed to configure the domain.
MissingParameter StartTime and EndTime can not be single. 400 The error message returned when only one of the StartTime and EndTime parameters is specified.
InvalidStartTime.Malformed Specified start time is malformed. 400 The error message returned when the format of the start time is invalid.
InvalidEndTime.Malformed Specified end time is malformed. 400 The error message returned when the format of the end time is invalid.
InvalidEndTime.Mismatch Specified end time does not math the specified start time. 400 The error message returned when the end time is earlier than the start time.
InvalidStartTime.ValueNotSupported Specified end time does not math the specified start time. 400 The error message returned when the interval between the end time and the start time is more than 90 days.