Queries the bandwidth data of one or more specified accelerated domain names. The bandwidth data is collected every minute.

Note
  • You can query data collected within the last seven days. The time range specified by the StartTime and EndTime parameters cannot exceed 24 hours in each call.
  • If StartTime is set but EndTime is not set, data collected one hour after the specified start time is queried.
  • If EndTime is set but StartTime is not set, data collected one hour before the end time is queried.

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 software development kits (SDKs).

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDcdnDomainRealTimeBpsData

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

DomainName String Yes example.com

The accelerated domain name. You can specify one or more accelerated domain names. Separate them with commas (,).

IspNameEn String No telecom

The name of the Internet service provider (ISP) for Dynamic Route for CDN (DCDN).

You can call the DescribeDcdnRegionAndIsp operation to query the most recent ISP list. If you do not specify an ISP, 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 specify a region, all regions are queried.

StartTime String No 2018-01-02T11:00:00Z

The beginning of the time range to query.

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

EndTime String No 2018-01-02T11:00:00Z

The end of the time range to query.

The time follows 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

A list of data returned.

BpsModel
Bps Float 16710625.733333332

The bandwidth data, in bit/s.

TimeStamp String 2018-01-02T11:05:00Z

The timestamp of the data returned. 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)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainRealTimeBpsData
&DomainName=example.com
&EndTime=2018-01-02T11:00:00Z
&IspNameEn=telecom
&LocationNameEn=beijing
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnDomainRealTimeBpsDataResponse>
	  <Data>
		    <BpsModel>
			      <TimeStamp>2018-01-02T11:05:00Z</TimeStamp>
			      <Bps>16710625.733333332</Bps>
		    </BpsModel>
		    <BpsModel>
			      <TimeStamp>2018-01-02T11:04:00Z</TimeStamp>
			      <Bps>59392614.8</Bps>
		    </BpsModel>
	  </Data>
	  <RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>
</DescribeDcdnDomainRealTimeBpsDataResponse>

JSON format

{
   "Data":{
      "BpsModel":[
         {
            "TimeStamp":"2018-01-02T11:05:00Z",
            "Bps":16710625.733333332
         },
         {
            "TimeStamp":"2018-01-02T11:04:00Z",
            "Bps":59392614.8
         }
      ]
   },
   "RequestId":"B49E6DDA-F413-422B-B58E-2FA23F286726"
}

Error codes

HttpCode Error code Error message Description
400 MissingTimeParameter The StartTime and EndTime must be both specified. The error message returned because both the StartTime and EndTime parameters must be set.
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 invalid.

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