Queries bandwidth monitoring data for one or more accelerated domain names.
Operation description
- You can call this operation up to 150 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 these 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
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:DescribeDomainBpsData | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,). By default, this operation queries bandwidth data for 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 ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2020-05-14T09:50: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.
| 2020-05-14T10:00:00Z |
| Interval | string | No | The time granularity of the data entries. 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 |
| IspNameEn | string | No | The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISP names. If you do not set this parameter, data of all ISPs is queried. | telecom |
| LocationNameEn | string | No | The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not specify a region, data in all regions is queried. | beijing |
Response parameters
Examples
Sample success responses
JSONformat
{
"EndTime": "2015-12-10T20:00Z",
"StartTime": "2020-05-14T09:50:00Z",
"RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
"IspNameEn": "unicom",
"LocationNameEn": "beijing",
"DomainName": "example.com",
"DataInterval": "300",
"BpsDataPerInterval": {
"DataModule": [
{
"HttpsDomesticValue": "11286111",
"Value": "11288111",
"OverseasValue": "2000",
"HttpsValue": "11288111",
"HttpsOverseasValue": "2000",
"TimeStamp": "2015-12-10T20:00:00Z",
"DomesticValue": "11286111"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | The specified start time is invalid. For more information, see the API references. |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | The format of the end time is invalid. Specify a valid value. |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | The start time is invalid. Set this parameter to another value and try again. |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | EndTime is earlier than StartTime. |
| 404 | InvalidDomain.NotFound | The domain [%s] does not belong to you. | - |
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 | see changesets | ||||||
|