Queries the bandwidth for one or more specified domain names for CDN.
Operation description
If you specify neither the StartTime parameter nor the EndTime parameter, the data in the last 24 hours is queried. Alternatively, you can specify both the StartTime and EndTime parameters to query data that is generated in the specified duration. You can query data for the last 90 days at most.
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 Resources
is 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:DescribeVodDomainBpsData | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | No | The domain name to be queried. If you do not specify this parameter, the merged data of all your domain names for CDN is returned. You can specify multiple domain names. Separate them with commas (,). | 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. Note
The minimum query interval is 5 minutes. If you do not specify this parameter, the data in the last 24 hours is queried.
| 2015-12-10T13:00:00Z |
EndTime | string | No | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2015-12-10T14:00:00Z |
Interval | string | No | The query interval. Unit: seconds. Valid values: 300, 3600, and 86400.
| 300 |
IspNameEn | string | No | The name of the Internet service provider (ISP). If you do not specify this parameter, the data of all ISPs is returned. | Alibaba |
LocationNameEn | string | No | The name of the region. If you do not specify this parameter, the data in all regions is returned. Only data in the China (Shanghai) region can be queried. | cn-shanghai |
Response parameters
Examples
Sample success responses
JSON
format
{
"EndTime": "2015-12-10T14:00:00Z",
"StartTime": "2015-12-10T13:00:00Z",
"RequestId": "3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F",
"IspNameEn": "Alibaba",
"LocationNameEn": "cn-shanghai",
"DomainName": "example.com",
"DataInterval": "300",
"BpsDataPerInterval": {
"DataModule": [
{
"HttpsDomesticValue": "11286111",
"Value": "11288111",
"OverseasValue": "2000",
"HttpsValue": "11288111",
"HttpsOverseasValue": "2000",
"TimeStamp": "2015-12-10T13:00:00Z",
"DomesticValue": "11286111"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-05-06 | The Error code has changed | View Change Details |
Common errors
The following table describes the common errors that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | The error message returned because the format of the start time is invalid. |
InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | The error message returned because the format of the end time is invalid. |
InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 400 | The error message returned because the time range that is specified by the EndTime and StartTime parameters exceeds 90 days. |
InvalidEndTime.Mismatch | Specified EndTime does not math the specified StartTime. | 400 | The error message returned because the end time is earlier than the start time. |