Queries bandwidth monitoring data for one or more accelerated domain names.

Usage notes

  • The maximum number of times that each user can call this operation per second is 150.
  • 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.
Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the time range to query, as described in the following table.

Time granularity

Time range to query

Historical data available

Data delay

5 minutes

3 days

93 days

15 minutes

1 hour

31 days

186 days

4 hours

1 day

366 days

366 days

04:00 on the next day

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 DescribeDomainBpsData

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

DomainName String No example.com

You can specify multiple domain names and separate them with commas (,). You can specify at most 500 domain names in each call.

By default, this operation queries the bandwidth values during back-to-origin routing for all accelerated domain names that belong to your Alibaba Cloud account.

StartTime String No 2020-05-14T09:50:00Z

The start 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 2020-05-14T10: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.
Interval String No 300

The time interval between the data entries. Unit: seconds.

The time granularity varies with the time range to query. Supported values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

IspNameEn String No telecom

The name of the Internet service provider (ISP) for your Alibaba Cloud CDN service. You can call the DescribeCdnRegionAndIsp operation to query ISP names.

If you do not set this parameter, all ISPs are queried.

LocationNameEn String No beijing

The name of the region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list.

If you do not set this parameter, the bandwidth monitoring data of the accelerated domain names in all regions is returned.

Response parameters

Parameter Type Example Description
EndTime String 2015-12-10T20:00Z

The end of the time range that was queried.

StartTime String 2020-05-14T09:50:00Z

The beginning of the time range that was queried.

RequestId String 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

The ID of the request.

IspNameEn String unicom

The name of the ISP for your Alibaba Cloud CDN service.

LocationNameEn String beijing

The name of the region.

DomainName String example.com

The accelerated domain name.

DataInterval String 300

The time interval between the returned entries. Unit: seconds.

BpsDataPerInterval Array of DataModule

The bandwidth values collected at each interval.

DataModule
HttpsDomesticValue String 11286111

The bandwidth values for HTTPS requests in the Chinese mainland. When the bandwidth data is queried by ISP, no value is returned.

Value String 11288111

The bandwidth value. Unit: bit/s.

OverseasValue String 2000

The bandwidth values in regions outside the Chinese mainland. When the bandwidth data is queried by ISP, no value is returned.

HttpsValue String 11288111

The bandwidth values for HTTPS requests. Unit: bit/s.

HttpsOverseasValue String 2000

The bandwidth values for HTTPS requests in regions outside the Chinese mainland. When the bandwidth data is queried by ISP, no value is returned.

TimeStamp String 2015-12-10T20:00:00Z

The timestamp of the data returned.

DomesticValue String 11286111

The bandwidth values in the Chinese mainland. When the bandwidth data is queried by ISP, no value is returned.

Examples

Sample requests

http://cdn.aliyuncs.com?Action=DescribeDomainBpsData
&DomainName=example.com
&StartTime=2020-05-14T09:50:00Z
&EndTime=2020-05-14T10:00:00Z
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDomainBpsDataResponse>
<RequestId>0AD87822-E8CE-436B-B434-C13F53B5B2D4</RequestId>
<EndTime>2020-05-14T10:00:00Z</EndTime>
<DataInterval>300</DataInterval>
<StartTime>2020-05-14T09:50:00Z</StartTime>
<BpsDataPerInterval>
    <DataModule>
        <OverseasValue>0</OverseasValue>
        <HttpsValue>0</HttpsValue>
        <Value>83.48266666666667</Value>
        <HttpsDomesticValue>0</HttpsDomesticValue>
        <TimeStamp>2020-05-14T09:50:00Z</TimeStamp>
        <HttpsOverseasValue>0</HttpsOverseasValue>
        <DomesticValue>83.48266666666667</DomesticValue>
    </DataModule>
    <DataModule>
        <OverseasValue>0</OverseasValue>
        <HttpsValue>0</HttpsValue>
        <Value>83.424</Value>
        <HttpsDomesticValue>0</HttpsDomesticValue>
        <TimeStamp>2020-05-14T09:55:00Z</TimeStamp>
        <HttpsOverseasValue>0</HttpsOverseasValue>
        <DomesticValue>83.424</DomesticValue>
    </DataModule>
</BpsDataPerInterval>
</DescribeDomainBpsDataResponse>

JSON format

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

{
  "RequestId" : "0AD87822-E8CE-436B-B434-C13F53B5B2D4",
  "EndTime" : "2020-05-14T10:00:00Z",
  "DataInterval" : 300,
  "StartTime" : "2020-05-14T09:50:00Z",
  "BpsDataPerInterval" : {
    "DataModule" : [ {
      "OverseasValue" : 0,
      "HttpsValue" : 0,
      "Value" : "83.48266666666667",
      "HttpsDomesticValue" : 0,
      "TimeStamp" : "2020-05-14T09:50:00Z",
      "HttpsOverseasValue" : 0,
      "DomesticValue" : "83.48266666666667"
    }, {
      "OverseasValue" : 0,
      "HttpsValue" : 0,
      "Value" : 83.424,
      "HttpsDomesticValue" : 0,
      "TimeStamp" : "2020-05-14T09:55:00Z",
      "HttpsOverseasValue" : 0,
      "DomesticValue" : 83.424
    } ]
  }
}

Error codes

HttpCode Error code Error message Description
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the format of the specified end time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. The error message returned because the specified start time is invalid. Set a valid value and try again.

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