Queries the bandwidth data by protocol.
Operation description
You can call this API operation up to 20 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 Interval, the maximum time period within which historical data is available, and the data delay vary based on the time range to query, as described in the following table.
| Time granularity | Time range per query | Historical data available | Data delay |
|---|---|---|---|
| 15 minutes | 3 days | 93 days | 15 minutes |
| 1 hour | 31 days | 186 days | 3 to 4 hours |
| 1 day | 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:DescribeVodDomainBpsDataByLayer | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The accelerated domain name. You can specify a maximum of 500 accelerated domain names. Separate multiple domain names 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. | 2019-01-23T12:35:12Z |
| 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. | 2019-01-23T12:40:12Z |
| Interval | string | No | The time interval between the data entries. Unit: seconds. The time granularity varies based on the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see the supported time granularity described in Usage notes. | 300 |
| IspNameEn | string | No | The name of the Internet service provider (ISP). | unicom |
| LocationNameEn | string | No | The name of the region. | beijing |
| Layer | string | No | The layer at which you want to query the data. Network layer: IPv4 and IPv6. Application layer: http, https, and quic. all: specifies that both the network and application layers are included. Default value: all. | IPv4 |
Response parameters
Examples
Sample success responses
JSONformat
{
"DataInterval": 300,
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"BpsDataInterval": {
"DataModule": [
{
"Value": 75.33,
"TrafficValue": 1000,
"TimeStamp": "2024-02-08T10:09:19Z"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.