Queries the byte hit ratios of accelerated domain names.
Usage notes
- The maximum number of times that each user can call this operation per second is 10.
- If you do not set StartTime or EndTime, data collected within the last hour is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
- The network traffic destined for different domain names may be redirected to the same origin server. Therefore, the byte hit ratios may be inaccurate. The accuracy of query results is based on the actual configurations.
The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.
Time granularity |
Time range to query |
Historical data available |
Data delay |
---|---|---|---|
1 minute |
1 hour |
7 days |
5 minutes |
5 minutes |
3 days |
93 days |
15 minutes |
1 hour |
31 days |
186 days |
4 hours |
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDomainRealTimeByteHitRateData |
The operation that you want to perform. Set the value to DescribeDomainRealTimeByteHitRateData. |
DomainName | String | Yes | example.com |
You can specify multiple domain names and separate them with commas (,). You can specify at most 100 domain names in each call. |
StartTime | String | No | 2020-05-15T09:13:00Z |
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 must be in UTC. |
EndTime | String | No | 2020-05-15T09:15: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.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 70A26B11-3673-479C-AEA8-E03FC5D3496D |
The ID of the request. |
Data | Array of ByteHitRateDataModel |
The response parameters. |
|
ByteHitRateDataModel | |||
ByteHitRate | Float | 0.8956940476262277 |
The byte hit ratio. The byte hit ratio is measured in percentage. |
TimeStamp | String | 2019-11-30T05:40:00Z |
The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Examples
Sample requests
https://cdn.aliyuncs.com/?Action=DescribeDomainRealTimeByteHitRateData
&DomainName=example.com
&StartTime=2020-05-15T09:13:00Z
&EndTime=2020-05-15T09:15:00Z
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDomainRealTimeByteHitRateDataResponse>
<RequestId>95C90452-100B-4226-A63D-2D570CE2A971</RequestId>
<Data>
<ByteHitRateDataModel>
<ByteHitRate>0.8956940476262277</ByteHitRate>
<TimeStamp>2020-05-15T09:13:00Z</TimeStamp>
</ByteHitRateDataModel>
<ByteHitRateDataModel>
<ByteHitRate>0.8429129920796812</ByteHitRate>
<TimeStamp>2020-05-15T09:14:00Z</TimeStamp>
</ByteHitRateDataModel>
</Data>
</DescribeDomainRealTimeByteHitRateDataResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "95C90452-100B-4226-A63D-2D570CE2A971",
"Data" : {
"ByteHitRateDataModel" : [ {
"ByteHitRate" : 0.8956940476262277,
"TimeStamp" : "2020-05-15T09:13:00Z"
}, {
"ByteHitRate" : 0.8429129920796812,
"TimeStamp" : "2020-05-15T09:14:00Z"
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. | The error message returned because the format of the specified start time or end time is invalid. |
For a list of error codes, visit the API Error Center.