Queries the number of queries per second (QPS) at a specific layer for one or more accelerated domain names. You can query data collected within the last 90 days.
Operation description
- You can call this operation up to 20 times per second per user.
- 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 these parameters, the request returns the data collected within the specified time range.
Time granularity
The time granularity supported by the Interval parameter varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.
| 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
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 |
|---|---|---|---|---|
| cdn:DescribeDomainQpsDataByLayer | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The accelerated domain name. You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,). By default, this operation queries the QPS of all accelerated domain names that belong to your Alibaba Cloud account. | example.com |
| StartTime | string | No | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in the ISO 8601 standard. The time is displayed in UTC. | 2019-11-30T05:33:00Z |
| EndTime | string | No | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in the ISO 8601 standard. The time is displayed in UTC. Note
The end time must be later than the start time.
| 2019-11-30T05:40:00Z |
| Interval | string | No | The time interval between the data entries to return. 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 Description. | 300 |
| IspNameEn | string | No | The name of the Internet service provider (ISP) for your Alibaba Cloud CDN service. You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not set this parameter, all ISPs are queried. | unicom |
| LocationNameEn | string | No | The name of the region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions are queried. | beijing |
| Layer | string | No | The layers at which you want to query the number of queries per second. Valid values:
| all |
Response parameters
Examples
Sample success responses
JSONformat
{
"EndTime": "2019-11-30T05:40:00Z",
"StartTime": "2019-11-30T05:33:00Z",
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"Layer": "all",
"DomainName": "example.com",
"DataInterval": "300",
"QpsDataInterval": {
"DataModule": [
{
"Value": "0.56",
"AccValue": "56",
"AccDomesticValue": "12",
"OverseasValue": "0.44",
"AccOverseasValue": "44",
"TimeStamp": "2015-12-10T21:00:00Z",
"DomesticValue": "0.12"
}
]
}
}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 value of parameter StartTime is malformed. | The specified start time is invalid. For more information, see the help documentation of this operation. |
| 400 | InvalidEndTime.Malformed | The specified value of parameter EndTime is malformed. | The specified EndTime parameter is invalid. |
| 400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | StartTime must be earlier than EndTime. |
| 400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | The specified start time is invalid. For more information, see the API references. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-06-13 | The Error code has changed | View Change Details |