Queries the bandwidth and traffic data by protocol for one or more domain names.
Operation description
You can query data in the last 90 days. You can specify up to 500 domain names. Separate multiple domain names with commas (,). The data of multiple domain names is aggregated and returned. The following section describes the time granularities of the data entries returned depending on the time range specified by the StartTime and EndTime parameters:
- If the time range is smaller than or equal to 3 days, the time granularity is 5 minutes.
- If the time range is larger than 3 days but smaller than or equal to 31 days, the time granularity is 1 hour.
- If the time range is larger than 31 days, the time granularity is 1 day.
QPS limit
You can call this operation up to 20 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
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 |
|---|---|---|---|---|
| live:DescribeLiveDomainBpsDataByLayer | get | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The streaming domain. You can specify multiple domain names by separating them with commas (,). If you leave this parameter empty, the data of all domain names within your Alibaba Cloud account is returned. | pull.aliyundoc.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 displayed in UTC. Note
If you do not specify this parameter, the data of the last 24 hours is returned by default. The minimum time granularity is 5 minutes.
| 2022-03-15T16: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 displayed in UTC. | 2022-03-16T16:59:59Z |
| Interval | string | No | The time granularity of the query. Unit: seconds. Valid values:
Note
| 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. Note
You can call the DescribeLiveRegionAndIsp operation to query available regions and ISPs.
| tele*** |
| LocationNameEn | string | No | The name of the region. If you do not specify this parameter, the data of all regions is returned. Note
You can call the DescribeLiveRegionAndIsp operation to query available regions and ISPs.
| hangzhou |
| Layer | string | No | The layer at which you want to query the data. Valid values:
| all |
Response parameters
Examples
Sample success responses
JSONformat
{
"BpsDataInterval": {
"DataModule": [
{
"TimeStamp": "2022-03-15T16:00:00Z",
"TrafficValue": "331",
"Value": "0.56"
}
]
},
"DataInterval": "300",
"RequestId": "BEA5625F-8FCF-48F4-851B-2A48566EA967"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | - |
| 400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | - |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | The end time does not match the start time. Make sure that the start and end times match. |
| 400 | InvalidStartTime.ValueNotSupported | Specified end time does not math the specified start time,And the time range does not exceed 90 days. | The start time and the end time do not match. The start time cannot be later than the end time, and the interval between the start time and the end time cannot exceed 90 days. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-29 | API Description Update. The Error code has changed | View Change Details |