Queries bandwidth data for one or more Border Gateway Protocol (BGP) accelerated domain names. The resolution of the data is 5 minutes or 1 hour.

Usage notes

  • If you do not set the StartTime or EndTime parameter, data within the last 24 hours is queried. If you set both the StartTime and EndTime parameters, data within the specified time range is queried. You must set both parameters or leave both of them empty.
  • If you specify multiple Internet service providers (ISPs), the data for the ISPs is aggregated.
  • You can query data within the last 90 days.
  • The maximum time range from the start time to the end time is 31 days. The start time is specified by the StartTime parameter and the end time is specified by the EndTime parameter.
  • If the time range from the start time to the end time is 72 hours or shorter, you can specify the interval as 5 minutes. If the time range is longer than 72 hours, you must specify the interval as 1 hour.
  • You can call this operation up to five times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameter

Parameter Type Required Example Description
Action String Yes DescribeDcdnBgpBpsData

The operation that you want to perform. Set the value to DescribeDcdnBgpBpsData.

Isp String No cu

The ISPs. If you need to specify multiple ISPs, separate them with commas (,). If you specify multiple ISPs, the data for the ISPs is aggregated. If you do not specify this parameter, the operation returns the data for all the ISPs.

Valid values:

  • cu: China Unicom
  • cmi: China Mobile
  • ct: China Telecom
StartTime String No 2018-11-29T00: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.

The minimum data collection interval is an hour.

If you do not set this parameter, data collected within the last 24 hours is queried.

EndTime String No 2018-11-30T00: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.

Interval String No 300

The data collection interval. Unit: second. Valid values: 300 and 3600. Default value: 300. The default value of 300 seconds is equal to 5 minutes. The value of this parameter varies based on the time range from the specified start time to the specified end time.

DeviceName String No devicename

The name of the device. If you specify this parameter, the data of the device is returned. Otherwise, the data of all devices are returned.

DevicePort String No 123

The port of the device. If you specify this parameter, the data of the port is returned. Otherwise, the data of all ports are returned. This parameter takes effect only when the DeviceName parameter is specified.

Response parameters

Parameter Type Example Description
EndTime String 2018-11-30T00:00:00Z

The end of the time range during which data was queried.

StartTime String 2018-11-29T00:00:00Z

The beginning of the time range during which data was queried.

RequestId String E9D3257A-1B7C-414C-90C1-8D07AC47BCAC

The ID of the request.

BgpDataInterval Array of BgpData

The BGP bandwidth data that is collected for each interval.

Out Float 183

The outbound bandwidth. Unit: bit/s.

In Float 318

The inbound bandwidth. Unit: bit/s.

TimeStamp String 2018-11-29T20:00:00Z

The timestamp of the data returned.

Examples

Sample request

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnBgpBpsData
&Isp=cu
&StartTime=2018-11-29T00:00:00Z
&EndTime=2018-11-30T00:00:00Z
&Interval=300
&DeviceName=devicename
&DevicePort=123
&Common request parameters

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnBgpBpsDataResponse>
<RequestId>E9D3257A-1B7C-414C-90C1-8D07AC47BCAC</RequestId>
<EndTime>2015-11-30T00:00:00Z</EndTime>
<StartTime>2015-11-29T00:00:00Z</StartTime>
<BgpDataInterval>
    <TimeStamp>2015-11-29T20:00:00Z</TimeStamp>
    <In>318</In>
    <Out>183</Out>
</BgpDataInterval>
<BgpDataInterval>
    <TimeStamp>2015-11-29T20:05:00Z</TimeStamp>
    <In>312</In>
    <Out>331</Out>
</BgpDataInterval>
</DescribeDcdnBgpBpsDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
  "EndTime" : "2015-11-30T00:00:00Z",
  "StartTime" : "2015-11-29T00:00:00Z",
  "BgpDataInterval" : [ {
    "TimeStamp" : "2015-11-29T20:00:00Z",
    "In" : 318,
    "Out" : 183
  }, {
    "TimeStamp" : "2015-11-29T20:05:00Z",
    "In" : 312,
    "Out" : 331
  } ]
}

Error codes

HttpCode Error code Error message Description
400 MissingTimeParameter The StartTime and EndTime must be both specified. The error message returned because no value is specified for the StartTime or EndTime parameter.
400 InvalidStartTime.Malformed The specified StartTime parameter is invalid. The error message returned because the format of the value specified for StartTime is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The error message returned because format of the value specified for EndTime is invalid. Specify the time in the ISO 8601 standard in the 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 value specified for the StartTime parameter is invalid. Specify a valid value.

For a list of error codes, visit the API Error Center.