Queries the bandwidth data for one or more ingest domains.
Operation description
Usage notes
- The bandwidth unit is bit/s.
- You can specify multiple domain names and separate them with commas (,).
- If you do not specify the StartTime or EndTime parameter, the data of the last 24 hours is queried. You can specify both the StartTime and EndTime parameters to query the data of a specified time range.
- You can query data in the last 90 days.
QPS limit
You can call this operation up to 100 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. For more information, see QPS limits.
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:DescribeLiveDomainPushBpsData | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The ingest domain. You can specify multiple ingest domains and separate them with commas (,). If you do not specify this parameter, the merged data of all your ingest domains is returned. | demo.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 in UTC. If you do not specify this parameter, the data of the last 24 hours is returned. | 2017-12-10T20:00: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. The end time must be later than the start time. | 2017-12-10T21:00:00Z |
| Interval | string | No | The time granularity of the query. Unit: seconds. Valid values:
The default value is 300. If you specify an invalid value or do not specify this parameter, the default value is used. | 300 |
| IspNameEn | string | No | The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query a list of available ISPs. If you do not specify this parameter, the data of all ISPs is returned. | alibaba |
| LocationNameEn | string | No | The name of the region. You can call the DescribeCdnRegionAndIsp operation to query a list of available regions. If you do not specify this parameter, the data of all regions is returned. | tianjin |
Response parameters
Examples
Sample success responses
JSONformat
{
"EndTime": "2017-12-10T21:00:00Z",
"StartTime": "2017-12-10T20:00:00Z",
"RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
"DomainName": "demo.aliyundoc.com",
"DataInterval": "300",
"BpsDataPerInterval": {
"DataModule": [
{
"BpsValue": "11288111",
"TimeStamp": "2017-12-10T20:00:00Z"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | - |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | - |
| 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 | The specified value of parameter StartTime is not supported. | The value specified for the StartTime parameter is invalid. |
For a list of error codes, visit the Service error codes.