Queries the bandwidth data for one or more ingest domains.
Usage notes
- The bandwidth unit is bit/s.
- You can specify multiple domain names by separating 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
Request parameters
Parameter |
Type |
Required |
Example |
Description |
Action | String | Yes | DescribeLiveDomainPushBpsData | The operation that you want to perform. Set the value to DescribeLiveDomainPushBpsData. |
DomainName | String | No | demo.aliyundoc.com | The ingest domain. You can specify multiple domain names by separating them with commas (,). If you do not specify this parameter, the merged data of all your ingest domains is returned. |
StartTime | String | No | 2017-12-10T20:00:00Z | 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. |
EndTime | String | No | 2017-12-10T21:00:00Z | 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. |
Interval | String | No | 300 | 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. |
IspNameEn | String | No | alibaba | 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. |
LocationNameEn | String | No | tianjin | 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. |
Response parameters
Parameter |
Type |
Example |
Description |
EndTime | String | 2017-12-10T21:00:00Z | The end of the time range during which data was queried. |
StartTime | String | 2017-12-10T20:00:00Z | The beginning of the time range during which data was queried. |
RequestId | String | 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F | The request ID. |
DomainName | String | demo.aliyundoc.com | The ingest domain. |
DataInterval | String | 300 | The time granularity of the query. |
BpsDataPerInterval | Array of DataModule | The bandwidth data that was collected at each interval. |
|
DataModule | |||
BpsValue | String | 11288111 | The bandwidth. Unit: bit/s. |
TimeStamp | String | 2017-12-10T20:00:00Z | The timestamp of the data returned. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainPushBpsData
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeLiveDomainPushBpsDataResponse>
<EndTime>2017-12-10T21:00:00Z</EndTime>
<StartTime>2017-12-10T20:00:00Z</StartTime>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<DomainName>demo.aliyundoc.com</DomainName>
<DataInterval>300</DataInterval>
<BpsDataPerInterval>
<BpsValue>11288111</BpsValue>
<TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
</BpsDataPerInterval>
</DescribeLiveDomainPushBpsDataResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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" : [ {
"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. | The format of the start time is invalid. Check whether the value of the StartTime parameter is valid. |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | The format of the end time is invalid. Check whether the value of the EndTime parameter is valid. |
400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | The end time does not match the start time. Check whether the value of the EndTime parameter matches. |
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, see Service error codes.