Queries the bandwidth data about one or more accelerated domain names. Data is collected every minute.

Note
  • The maximum number of times that each user can call this operation per second is 100.
  • The bandwidth data is collected every minute.
  • If StartTime is set but EndTime is not set, data within the hour that starts from StartTime is queried.
  • If EndTime is set but StartTime is not set, the data within the last hour that precedes EndTime is queried.
  • You can specify multiple domain names (no more than 500) and separate them with commas (,).
  • You can query data within the last seven days. The interval at which data is collected is based on the time range specified by StartTime and EndTime.
    • If the time range is less than or equal to 1 hour, data is collected every minute.
    • If the time range is longer than 1 hour but less than or equal to three days, data is collected every 5 minutes.
    • If the time range is longer than three days but less than or equal to 31 days, data is collected every hour.
    • If the time range is longer than 31 days, data is collected every 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 DescribeDomainRealTimeBpsData

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

DomainName String Yes example.com

The accelerated domain names. Separate domain names with commas (,).

Note You can specify at most 500 accelerated domain names in each call.
IspNameEn String No telecom

The name of the ISP.

You can call the DescribeCdnRegionAndIsp operation to query the most recent region 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
Data Array of BpsModel

The bandwidth information about the accelerated domain names.

BpsModel
Bps Float 16710625.733333332

The bandwidth value. Unit: bit/s.

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

The timestamp of the data entry. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RequestId String B49E6DDA-F413-422B-B58E-2FA23F286726

The ID of the request.

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 

<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 

{
   "Data":{
      "BpsModel":[
         {
            "TimeStamp":"2019-11-30T05:41:00Z",
            "Bps":16710625.733333332
         },
         {
            "TimeStamp":"2019-11-30T05:42:00Z",
            "Bps":59392614.8
         }
      ]
   },
   "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.