Queries monitoring information about bandwidth data of the Layer-4 accelerated network for one or more specified accelerated domain names. You can query data collected within the last 90 days.
- Unit: bit/s.
- If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDcdnDomainIpaBpsData |
The operation that you want to perform. Set the value to DescribeDcdnDomainIpaBpsData. |
DomainName | String | No | example.com |
The accelerated domain names. Separate multiple domain names with commas (,). By default, all accelerated domain names are queried. |
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. |
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. Note The end time must be later than the start time.
|
TimeMerge | String | No | 1 |
Specify whether to automatically calculate the value of the Interval parameter. If you set the TimeMerge parameter to 1, the value of the Interval parameter is automatically assigned based on the StartTime and EndTime parameters. You can specify this parameter or the Interval parameter. |
Interval | String | No | 300 |
The unit of time in which data is collected: seconds. The value varies based on the values of the StartTime and EndTime parameters. Valid values:
|
FixTimeGap | String | No | false |
Specify whether to implement padding with zeros. Valid values:
|
IspNameEn | String | No | Unicom |
The name of the Internet service provider (ISP). If you do not set this parameter, all ISPs are queried. You can call the DescribeDcdnRegionAndIsp operation to query ISP names. |
LocationNameEn | String | No | beijing |
The name of the region. If you do not set this parameter, all regions are queried. You can call the DescribeDcdnRegionAndIsp operation to query region names. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
BpsDataPerInterval | Array of DataModule |
The bandwidth data that is collected for each interval. |
|
DataModule | |||
IpaBps | Float | 11288111 |
The bandwidth value. Unit: bit/s. |
TimeStamp | String | 2017-12-10T20:00:00Z |
The timestamp of the data entry. |
DataInterval | String | 300 |
The time interval at which data is collected. |
DomainName | String | example.com |
The information about the accelerated domain name. |
EndTime | String | 2017-12-10T21:00:00Z |
The end time. |
RequestId | String | 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F |
The ID of the request. |
StartTime | String | 2017-12-10T20:00:00Z |
The start time. |
Examples
Sample requests
http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainIpaBpsData
&DomainName=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T21:00:00Z
&<Common request parameters>
Sample success responses
XML
format
<DescribeDcdnDomainIpaBpsDataResponse>
<BpsDataPerInterval>
<DataModule>
<TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
<IpaBps>11288111</IpaBps>
</DataModule>
<DataModule>
<TimeStamp>2017-12-10T20:05:00Z</TimeStamp>
<IpaBps>11288111</IpaBps>
</DataModule>
</BpsDataPerInterval>
<DomainName>example.com</DomainName>
<DataInterval>300</DataInterval>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<StartTime>2017-12-10T20:00:00Z</StartTime>
<EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeDcdnDomainIpaBpsDataResponse>
JSON
format
{
"BpsDataPerInterval": {
"DataModule": [
{
"TimeStamp": "2017-12-10T20:00:00Z",
"IpaBps": 11288111
},
{
"TimeStamp": "2017-12-10T20:05:00Z",
"IpaBps": 11288111
}
]
},
"DomainName": "example.com",
"DataInterval": "300",
"RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
"StartTime": "2017-12-10T20:00:00Z",
"EndTime": "2017-12-10T21:00:00Z"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | The error message returned because the StartTime and EndTime parameters must be set. |
400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | The error message returned because the format of the specified end time is invalid. Specify the time in the ISO 8601 standard in yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | The error message returned because the end time is earlier than the start time. |
400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | The error message returned because the specified start time is not supported. Specify a valid value. |
For a list of error codes, visit the API Error Center.