Queries the bandwidth data at a specified time for an accelerated domain name.

Usage notes

  • The bandwidth is measured in bit/s.
  • You can specify only one domain name in each query.
  • The data is collected at an interval of five minutes.
  • The maximum number of times that each user can call this operation per second is 20.

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 DescribeDomainBpsDataByTimeStamp

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

DomainName String Yes example.com

The accelerated domain name. You can specify only one domain name in each query.
IspNames String Yes unicom,telecom

The names of the Internet service providers (ISPs). Separate multiple ISP names with commas (,).

You can call the DescribeCdnRegionAndIsp operation to query regions.

LocationNames String Yes liaoning,guangxi

The names of the regions. Separate multiple regions with commas (,).

You can call the DescribeCdnRegionAndIsp operation to query regions.

TimePoint String Yes 2019-11-30T05:40:00Z

The beginning of the time range that was queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.

The data is collected at an interval of five minutes.

Response parameters

Parameter Type Example Description
DomainName String example.com

The accelerated domain name.
BpsDataList Array of BpsDataModel

A list of bandwidth values queried by ISP and region.
BpsDataModel
LocationName String Liaoning

The name of the region.
IspName String unicom

The name of the ISP for your Content Delivery Network (CDN) service.
Bps Long 52119553

The bandwidth value.
TimeStamp String 2019-11-30T05:40:00Z

The timestamp of the data.
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.
TimeStamp String 2019-11-30T05:40:00Z

The timestamp of the data.

Examples

Sample requests

http://cdn.aliyuncs.com/?Action=DescribeDomainBpsDataByTimeStamp
&DomainName=example.com
&LocationNames=liaoning,guangxi
&IspNames=unicom,telecom
&TimePoint=2019-11-30T05:40:00Z
&<Common request parameters>

Sample success responses

XML format 

<DescribeDomainBpsDataByTimeStampResponse>
      <BpsDataList>
            <BpsDataModel>
                  <LocationName>Liaoning</LocationName>
                  <Bps>880996111</Bps>
                  <IspName>telecom</IspName>
            </BpsDataModel>
            <BpsDataModel>
                  <LocationName>Liaoning</LocationName>
                  <Bps>52119553</Bps>
                  <IspName>unicom</IspName>
            </BpsDataModel>
            <BpsDataModel>
                  <LocationName>Guangxi</LocationName>
                  <Bps>51295137</Bps>
                  <IspName>telecom</IspName>
            </BpsDataModel>
            <BpsDataModel>
                  <LocationName>Guangxi</LocationName>
                  <Bps>18673571</Bps>
                  <IspName>unicom</IspName>
            </BpsDataModel>
            <TimeStamp>2016-08-01T22:00Z</TimeStamp>
        <RequestId>7682DE14-3B4D-48D0-9B7C-DD3C8C3E1C78</RequestId>
        <DomainName>example.com</DomainName>
      </BpsDataList>
</DescribeDomainBpsDataByTimeStampResponse>

JSON format 

{
    "TimeStamp": "2016-08-01T22:00Z",
    "BpsDataList": {
        "BpsDataModel": [{
            "LocationName": "Liaoning",
            "Bps": 880996111,
            "IspName": "telecom"
        }, {
            "LocationName": "Liaoning",
            "Bps": 52119553,
            "IspName": "unicom"
        }, {
            "LocationName": "Guangxi",
            "Bps": 51295137,
            "IspName": "telecom"
        }, {
            "LocationName": "Guangxi",
            "Bps": 18673571,
            "IspName": "unicom"
        }]
    },
    "RequestId": "7682DE14-3B4D-48D0-9B7C-DD3C8C3E1C78",
    "DomainName": "example.com"
}

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 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 not supported.

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