Queries back-to-origin bandwidth for one or more accelerated domain names. You can query data that is collected within the last 90 days.

Note
  • The bandwidth is measured in bit/s.
  • If you do not specify the StartTime and EndTime parameters, the operation returns the data that is collected within the last 24 hours. If you specify the StartTime and EndTime parameters, the operation returns the data that is collected within the specified time range.
  • The maximum number of times that each user can call this operation per second is 100.

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. You can specify multiple accelerated domain names and separate them 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 for querying data. Unit: seconds. The value varies based on the values of the StartTime and EndTime parameters. Valid values:

  • If the time range between StartTime and EndTime is less than 3 days, the valid values are 300, 3600, and 86400. If you do not specify a value for this parameter, 300 is used.
  • If the time range between StartTime and EndTime is greater than or equal to 3 days and less than 31 days, the valid values are 3600 and 86400. If you do not specify a value for this parameter, 3600 is used.
  • If the time range between StartTime and EndTime is 31 days or more, the valid value is 86400. If you do not specify a value for this parameter, 86400 is used.

Response parameters

Parameter Type Example Description
DataInterval String 300

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

DomainName String example.com

The accelerated domain name.

EndTime String 2019-12-11T00:00:00Z

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

OriginBpsDataPerInterval Array of DataModule

The back-to-origin bandwidth returned at each interval.

DataModule
DynamicHttpOriginBps Float 100

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

DynamicHttpsOriginBps Float 100

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

OriginBps Float 100

The bandwidth consumed for fetching content from the origin.

StaticHttpOriginBps Float 100

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

StaticHttpsOriginBps Float 100

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

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

The timestamp of the queried data.

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

The ID of the request.

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

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

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

<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

{
    "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

HttpCode Error code Error message Description
400 MissingTimeParameter The StartTime and EndTime must be both specified. The error message returned because the StartTime or EndTime parameter is not set.
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 StartTime parameter is invalid. Specify a valid value.

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