Queries back-to-origin bandwidth of one or more accelerated domain names.

Description

  • You can call this operation up to 100 times per second per account.
  • If you do not set the StartTime or EndTime parameters, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
Time granularity

The time granularity supported by the Interval parameter varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.

Time granularity

Maximum time range per 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 DescribeDcdnDomainOriginBpsData

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

DomainName String No example.com

The accelerated domain name. Separate multiple accelerated domain names with commas (,). If you do not specify a value for this parameter, all accelerated domain names are queried.

StartTime String No 2019-12-10T00:00: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-12-11T00: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 to return. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Description.

Response parameters

Parameter Type Example Description
EndTime String 2019-12-11T00:00:00Z

The end of the time range during which data was queried.

StartTime String 2019-12-10T00:00:00Z

The beginning of the time range during which data was queried.

RequestId String 7CBCD6AD-B016-42E5-AE0B-B3731DE8F755

The ID of the request.

DomainName String example.com

The accelerated domain name.

DataInterval String 300

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

OriginBpsDataPerInterval Array of DataModule

The back-to-origin bandwidth returned at each interval. Unit: bit/s.

DataModule
DynamicHttpOriginBps Float 100

The bandwidth that was consumed for fetching dynamic content from the origin over HTTP.

StaticHttpOriginBps Float 100

The bandwidth that was consumed for fetching static content from the origin over HTTP.

TimeStamp String 2019-12-10T00:00:00Z

The timestamp of the data returned.

StaticHttpsOriginBps Float 100

The bandwidth that was consumed for fetching static content from the origin over HTTPS.

OriginBps Float 100

The bandwidth that was consumed for fetching content from the origin.

DynamicHttpsOriginBps Float 100

The bandwidth that was consumed for fetching dynamic content from the origin over HTTPS.

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainOriginBpsData
&DomainName=example.com
&StartTime=2019-12-10T00:00:00Z
&EndTime=2019-12-11T00:00:00Z
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeDcdnDomainOriginBpsDataResponse>
<DomainName>example.com</DomainName>
<DataInterval>300</DataInterval>
<RequestId>73769293-5997-491D-8FEA-B98F6E59DF38</RequestId>
<OriginBpsDataPerInterval>
    <DataModule>
        <DynamicHttpOriginBps>0</DynamicHttpOriginBps>
        <TimeStamp>2019-12-10T21:00:00Z</TimeStamp>
        <OriginBps>0</OriginBps>
        <StaticHttpOriginBps>0</StaticHttpOriginBps>
        <StaticHttpsOriginBps>0</StaticHttpsOriginBps>
        <DynamicHttpsOriginBps>0</DynamicHttpsOriginBps>
    </DataModule>
</OriginBpsDataPerInterval>
<EndTime>2019-12-10T21:05:00Z</EndTime>
<StartTime>2019-12-10T21:00:00Z</StartTime>
</DescribeDcdnDomainOriginBpsDataResponse>

JSON format 

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

{
  "DomainName" : "example.com",
  "DataInterval" : 300,
  "RequestId" : "73769293-5997-491D-8FEA-B98F6E59DF38",
  "OriginBpsDataPerInterval" : {
    "DataModule" : [ {
      "DynamicHttpOriginBps" : 0,
      "TimeStamp" : "2019-12-10T21:00:00Z",
      "OriginBps" : 0,
      "StaticHttpOriginBps" : 0,
      "StaticHttpsOriginBps" : 0,
      "DynamicHttpsOriginBps" : 0
    } ]
  },
  "EndTime" : "2019-12-10T21:05:00Z",
  "StartTime" : "2019-12-10T21:00:00Z"
}

Error codes

HTTP status code Error code Error message Description
400 MissingTimeParameter The StartTime and EndTime must be both specified. The error message returned because no value is specified for the StartTime or EndTime parameter.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The error message returned because the format of the EndTime parameter 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 end time is earlier than the start time.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the value specified for the StartTime parameter is invalid. Specify a valid value.

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