Queries the bandwidth data for one or more domain names.
Usage note
- If you do not set the StartTime parameter or the EndTime parameter, the data of the last 24 hours is queried. If you set the StartTime and EndTime parameters, the data of the specified time range is queried.
- If you specify only the StartTime parameter but not the EndTime parameter, the data of the hour following the specified start time is queried.
- If you specify only the EndTime parameter but not the StartTime parameter, the data of the hour preceding the specified end time is queried.
- You can query the data of the last 90 days at most.
- This operation is called to monitor data. The data is collected and processed in a manner different from that for billing. Therefore, the data that is returned by this operation cannot be used as a reference to calculate the resource usage for billing.
QPS limit
A single user can perform a maximum of 100 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLiveDomainBpsData |
The operation that you want to perform. Set the value to DescribeLiveDomainBpsData. |
DomainName | String | No | example.com |
The domain name. Separate multiple domain names with commas (,). |
StartTime | String | No | 2017-12-10T08: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. |
EndTime | String | No | 2017-12-10T09:00:00Z |
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. |
Interval | String | No | 300 |
The interval at which data is to be queried. Unit: seconds. Valid values:
Note
|
LocationNameEn | String | No | tianjin |
The name of the region in which you want to query data. To query regions, call the DescribeCdnRegionAndIsp operation. |
IspNameEn | String | No | alibaba |
The name of the Internet service provider (ISP). To query ISPs, call the DescribeCdnRegionAndIsp operation. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DomainName | String | example.com |
The domain name. |
DataInterval | String | 300 |
The interval at which data was queried. Unit: seconds. |
BpsDataPerInterval | Array of DataModule |
The bandwidth data that was collected for each interval. |
|
DataModule | |||
TimeStamp | String | 2017-12-10T08:00:05Z |
The timestamp of the returned data. |
BpsValue | String | 11288111 |
The bandwidth. Unit: bit/s. |
HttpBpsValue | String | 11286111 |
The bandwidth over HTTP. Unit: bit/s. |
HttpsBpsValue | String | 2000 |
The bandwidth over HTTPS. Unit: bit/s. |
RequestId | String | B955107D-E658-4E77-B913-E0AC3D31693E |
The ID of the request. |
StartTime | String | 2017-12-10T08:00:00Z |
The beginning of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
EndTime | String | 2017-12-10T09:00:00Z |
The end of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainBpsData
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveDomainBpsDataResponse>
<BpsDataPerInterval>
<DataModule>
<BpsValue>11288111</BpsValue>
<HttpBpsValue>11286111</HttpBpsValue>
<HttpsBpsValue>2000</HttpsBpsValue>
<TimeStamp>2017-12-10T12:00:00Z</TimeStamp>
</DataModule>
<DataModule>
<BpsValue>1288111</BpsValue>
<HttpBpsValue>1286111</HttpBpsValue>
<HttpsBpsValue>2000</HttpsBpsValue>
<TimeStamp>2017-12-10T12:05:00Z</TimeStamp>
</DataModule>
</BpsDataPerInterval>
<DataInterval>300</DataInterval>
<DomainName>example.com</DomainName>
<EndTime>2017-12-10T15:00:00Z</EndTime>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<StartTime>2017-12-10T12:00:00Z</StartTime>
</DescribeLiveDomainBpsDataResponse>
JSON
format
{
"BpsDataPerInterval":{
"DataModule":[
{
"BpsValue":"11288111",
"HttpBpsValue":"11286111",
"HttpsBpsValue":"2000",
"TimeStamp":"2017-12-10T12:00:00Z"
},
{
"BpsValue":"1288111",
"HttpBpsValue":"1286111",
"HttpsBpsValue":"2000",
"TimeStamp":"2017-12-10T12:05:00Z"
}
]
},
"DataInterval":"300",
"DomainName":"example.com",
"EndTime":"2017-12-10T15:00:00Z",
"RequestId":"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
"StartTime":"2017-12-10T12:00:00Z"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | The error message returned because 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 error message returned because 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 error message returned because the end time is earlier than the start time. Check whether the values of the StartTime and EndTime parameters are valid. |
For a list of error codes, visit the API Error Center.