Queries the request hit ratio that is measured in percentage.
Description
- The maximum number of times that each user can call this operation per second is 100.
- If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
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 time range to query, as described in the following table.
Time granularity |
Time range to 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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDomainReqHitRateData |
The operation that you want to perform. Set the value to DescribeDomainReqHitRateData. |
DomainName | String | No | example.com |
You can specify multiple domain names and separate them with commas (,). You can specify at most 500 domain names in each call. By default, this operation queries the bandwidth values of back-to-origin requests for all accelerated domain names that belong to your Alibaba Cloud account. |
StartTime | String | No | 2017-12-21T08:00:00Z |
The start of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
EndTime | String | No | 2017-12-22T08:00:00Z |
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 must be in UTC. Note The end time must be later than the start time.
|
Interval | String | No | 300 |
The time interval between the data entries. Unit: seconds. The time granularity varies with the time range to query. Supported values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
EndTime | String | 2017-12-22T08:00:00Z |
The end of the time range that was queried. |
StartTime | String | 2017-12-21T08:00:00Z |
The beginning of the time range that was queried. |
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
DomainName | String | example.com |
The accelerated domain name. |
DataInterval | String | 300 |
The time interval between the data entries returned. Unit: seconds. |
ReqHitRateInterval | Array of DataModule |
The request hit ratio at each time interval. The hit ratio is measured in percentage. |
|
DataModule | |||
Value | String | 100.0 |
The byte hit ratio. |
TimeStamp | String | 2017-12-22T08:00:00:00Z |
The timestamp of the data returned. |
HttpsValue | String | 50.0 |
The hit ratio of HTTPS requests. |
Examples
Sample requests
http(s)://cdn.aliyuncs.com/?Action=DescribeDomainReqHitRateData
&DomainName=example.com
&StartTime=2017-12-21T08:00:00Z
&EndTime=2017-12-22T08:00:00Z
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDomainReqHitRateDataResponse>
<DomainName>example.com</DomainName>
<DataInterval>300</DataInterval>
<RequestId>5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD</RequestId>
<StartTime>2017-12-21T08:00:00Z</StartTime>
<EndTime>2017-12-22T08:00:00Z</EndTime>
<ReqHitRateInterval>
<DataModule>
<TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
<Value>100.0</Value>
<HttpsValue>50.0</HttpsValue>
</DataModule>
<DataModule>
<TimeStamp>2015-12-10T20:35:00Z</TimeStamp>
<Value>100.0</Value>
<HttpsValue>50.0</HttpsValue>
</DataModule>
</ReqHitRateInterval>
</DescribeDomainReqHitRateDataResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"DomainName" : "example.com",
"DataInterval" : "300",
"RequestId" : "5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD",
"StartTime" : "2017-12-21T08:00:00Z",
"EndTime" : "2017-12-22T08:00:00Z",
"ReqHitRateInterval" : {
"DataModule" : [ {
"TimeStamp" : "2015-12-10T21:00:00Z",
"Value" : "100.0",
"HttpsValue" : "50.0"
}, {
"TimeStamp" : "2015-12-10T20:35:00Z",
"Value" : "100.0",
"HttpsValue" : "50.0"
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section. |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | The error message returned because the format of the specified end time is invalid. For more information about the time format, see the Request parameters section. |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | The error message returned because the specified start time is invalid. Rectify the start time and try again. |
For a list of error codes, visit the API Error Center.