DescribeDcdnDomainHitRateData - Edge Security Acceleration

Queries the byte hit ratios for an accelerated domain name.

Operation description

You can call this operation up to 100 times per second per account.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.

Time granularity The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table. |Time granularity |Maximum time range per query |Historical data available |Data delay | -------------- | -------------- | ------ |5 minutes |3 days |93 days |15 minutes |1 hour |31 days |186 days |4 hours |1 day |366 days |366 days |04:00 on the next day

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify only one domain name. If you do not specify a value for this parameter, all domain names are queried.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time needs to be in UTC.	2018-03-02T12:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time needs to be in UTC. The end time needs to be later than the start time.	2018-03-02T15:00:00Z
Interval	string	No	The time granularity for a query. Unit: seconds. The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.	300

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2018-03-02T15:00:00Z
StartTime	string	The beginning of the time range during which data was queried.	2018-03-02T12:00:00Z
RequestId	string	The ID of the request.	4D07ABFE-4737-4834-B1B9-A661308C47B4
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	3600
HitRatePerInterval	array<object>	The byte hit ratio at each time interval. The byte hit ratio is measured in percentage.
DataModule	object
TimeStamp	string	The timestamp of the returned data.	2018-03-02T13:00:00Z
ByteHitRate	float	The byte hit ratio.	0
ReqHitRate	float	The request hit ratio.	0

Examples

Sample success responses

JSONformat

{
  "EndTime": "2018-03-02T15:00:00Z",
  "StartTime": "2018-03-02T12:00:00Z",
  "RequestId": "4D07ABFE-4737-4834-B1B9-A661308C47B4",
  "DomainName": "example.com",
  "DataInterval": "3600",
  "HitRatePerInterval": {
    "DataModule": [
      {
        "TimeStamp": "2018-03-02T13:00:00Z",
        "ByteHitRate": 0,
        "ReqHitRate": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

For a list of error codes, visit the Service error codes.