Queries the bandwidth data about one or more accelerated domain names.

Usage notes

  • The maximum number of times that each user can call this operation per second is 100.
  • If you do not set StartTime or EndTime, data collected within the last hour is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.

Time granularity

Time range to query

Historical data available

Data delay

1 minute

1 hour

7 days

5 minutes

5 minutes

3 days

93 days

15 minutes

1 hour

31 days

186 days

4 hours

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 DescribeDomainRealTimeBpsData

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

DomainName String Yes example.com

The accelerated domain names. You can specify multiple accelerated domain names and separate them with commas (,).

Note You can specify at most 500 accelerated domain names in each call.
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 the most recent ISP list. 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, all regions are queried.

StartTime String No 2019-11-30T05:33: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 2019-11-30T05:40: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.

Response parameters

Parameter Type Example Description
RequestId String B49E6DDA-F413-422B-B58E-2FA23F286726

The ID of the request.

Data Array of BpsModel

The response parameters.

BpsModel
Bps Float 16710625.733333332

The bandwidth. Unit: bit/s.

TimeStamp String 2019-11-30T05:41:00Z

The timestamp of the data entry. The time follows the ISO 8601 standard. The time is displayed in UTC.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainRealTimeBpsData
&DomainName=example.com
&EndTime=2019-11-30T05:40:00Z
&StartTime=2019-11-30T05:33:00Z
&IspNameEn=telecom
&LocationNameEn=beijing
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDomainRealTimeBpsDataResponse>
<Data>
    <BpsModel>
        <TimeStamp>2019-11-30T05:41:00Z</TimeStamp>
        <Bps>16710625.733333332</Bps>
    </BpsModel>
    <BpsModel>
        <TimeStamp>2019-11-30T05:42:00Z</TimeStamp>
        <Bps>59392614.8</Bps>
    </BpsModel>
</Data>
<RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>
</DescribeDomainRealTimeBpsDataResponse>

JSON format

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

{
  "Data" : {
    "BpsModel" : [ {
      "TimeStamp" : "2019-11-30T05:41:00Z",
      "Bps" : 1.6710625733333332E7
    }, {
      "TimeStamp" : "2019-11-30T05:42:00Z",
      "Bps" : 5.93926148E7
    } ]
  },
  "RequestId" : "B49E6DDA-F413-422B-B58E-2FA23F286726"
}

Error codes

HttpCode Error code Error message Description
400 InvalidTime.Malformed Specified StartTime or EndTime is malformed. The error message returned because the format of the specified start time or end time is invalid.

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