Queries the byte hit ratio for one or more accelerated domains. Request hit ratios are measured in percentage.
Operation description
- This operation is supported only in the China (Shanghai) region.
- You can specify a maximum of 500 accelerated domain names.
- If you specify neither
StartTimenorEndTime, the data of the last 24 hours is queried. You can specify bothStartTimeandEndTimeparameters to query data of a specified time range.
Time granularity
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 when you do not set Interval.
| Time granularity | Time range per query | Historical data available | Data delay |
|---|---|---|---|
| 5 minutes | Time range per query < 3 days | 93 days | 15 minutes |
| 1 hour | 3 days ≤ Time range per query < 31 days | 186 days | 3 to 4 hours |
| 1 day | 31 days ≤ Time range per query ≤ 90 days | 366 days | 4 hours in most cases, not more than 24 hours |
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:DescribeVodDomainReqHitRateData | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The accelerated domain name.
| 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 must be in UTC. | 2023-12-21T08: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 must be in UTC. Note
The end time must be later than the start time.
| 2023-12-22T08:00:00Z |
| Interval | string | No | The time granularity. Unit: seconds. Valid values: 300, 3600, and 86400. If you leave this parameter empty or specify an invalid value, the default value is used. The supported time granularity varies based on the time range specified by
| 300 |
Response parameters
Examples
Sample success responses
JSONformat
{
"EndTime": "2023-12-22T08:00:00Z",
"RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
"Data": {
"DataModule": [
{
"Value": "100",
"TimeStamp": "2023-12-21T08:00:00Z",
"HttpsValue": "50"
}
]
},
"StartTime": "2023-12-21T08:00:00Z",
"DomainName": "example.com",
"DataInterval": "300"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|