DescribeDcdnBgpBpsData - API Reference| Alibaba Cloud Documentation Center

Before you call this operation, pay attention to the following notes:

If you specify neither the StartTime parameter nor the EndTime parameter, the data within the last 24 hours is returned. If you specify the StartTime and EndTime parameters, the data within the specified time range is returned. You must specify both parameters or leave both parameters empty.
If you specify multiple Internet service providers (ISPs), the bandwidth data for the ISPs is aggregated.
You can query the data for up to 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.

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 parameters


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 bandwidth data for the ISPs is aggregated. By default, the operation returns the bandwidth 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. By default, the bandwidth data that is collected within the last 24 hours is returned.
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.

Response parameters


Parameter	Type	Example	Description
BgpDataInterval	Array of BgpData		The BGP bandwidth data that is collected for each interval.
In	Float	318	The inbound bandwidth. Unit: bit/s.
Out	Float	183	The outbound bandwidth. Unit: bit/s.
TimeStamp	String	2018-11-29T20:00:00Z	The timestamp of the returned data.
StartTime	String	2018-11-29T00:00:00Z	The start time.
EndTime	String	2018-11-30T00:00:00Z	The end time.
RequestId	String	E9D3257A-1B7C-414C-90C1-8D07AC47BCAC	The ID of the request.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=DescribeDcdnBgpBpsData
&StartTime=2015-11-29T00:00:00Z
&EndTime=2015-11-30T00:00:00Z
&<Common request parameters>

Sample success responses

XML format

<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

{
    "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 only the StartTime parameter or the EndTime parameter is specified. Specify both parameters or leave both parameters empty.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The error message returned because the format of the specified start time 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 the format of the specified end time 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 specified end time is earlier than the specified start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The error message returned because the specified start time is not supported. Specify another value.

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