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

Note
  • If you do not specify the StartTime and EndTime parameters, the data that is collected within the previous 24 hours is collected. If you specify the StartTime and EndTime parameters, the data that is collected within the time range that you specify is collected.
  • Unit: bytes.
  • 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 DescribeDcdnDomainOriginTrafficData

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

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 2017-12-10T20: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 2017-12-10T21: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 resolution of the queried 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 three days, the valid values are 300, 3600, and 86400. If you do not specify a value for this parameter, the value 300 is used.
  • If the time range between StartTime and EndTime is greater than or equal to three days and less than 31 days, the valid values are 3600 and 86400. If you do not specify a value for this parameter, the value 3600 is used.
  • If the time range between StartTime and EndTime is greater than or equal to 31 days, the valid value is 86400. If you do not specify a value for this parameter, the value 86400 is used.

Response parameters

Parameter Type Example Description
DataInterval String 300

The interval at which the data entries were returned. Unit: seconds.

DomainName String example.com

The accelerated domain name.

EndTime String 2017-12-10T21:00:00Z

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

OriginTrafficDataPerInterval Array of DataModule

The amount of back-to-origin network traffic that was collected at each interval.

DataModule
DynamicHttpOriginTraffic Float 1000

The amount of back-to-origin traffic that was consumed to deliver dynamic content over HTTP.

DynamicHttpsOriginTraffic Float 500

The amount of back-to-origin traffic that was consumed to deliver dynamic content over HTTPS.

OriginTraffic Float 100

The amount of back-to-origin traffic.

StaticHttpOriginTraffic Float 0

The amount of back-to-origin traffic that was consumed to deliver static content over HTTP.

StaticHttpsOriginTraffic Float 100

The amount of back-to-origin traffic that was consumed to deliver static content over HTTPS.

TimeStamp String 2017-12-10T21:00:00Z

The timestamp when the data was returned.

RequestId String A666D44F-19D6-490E-97CF-1A64AB962C57

The ID of the request.

StartTime String 2017-12-10T20:00:00Z

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

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainOriginTrafficData
&DomainName=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T21:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnDomainOriginTrafficDataResponse>
      <DomainName>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <OriginTrafficDataPerInterval>
            <DataModule>
                  <TimeStamp>2017-12-10T21:00:00Z</TimeStamp>
                  <OriginTraffic>1000</OriginTraffic>
                  <DynamicHttpOriginTraffic>500</DynamicHttpOriginTraffic>
                  <DynamicHttpsOriginTraffic>500</DynamicHttpsOriginTraffic>
                  <StaticHttpOriginTraffic>0</StaticHttpOriginTraffic>
                  <StaticHttpsOriginTraffic>0</StaticHttpsOriginTraffic>
            </DataModule>
      </OriginTrafficDataPerInterval>
      <RequestId>A666D44F-19D6-490E-97CF-1A64AB962C57</RequestId>
      <StartTime>2017-12-10T20:00:00Z</StartTime>
      <EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeDcdnDomainOriginTrafficDataResponse>

JSON format

{
    "DomainName": "example.com",
    "DataInterval": "300",
    "OriginTrafficDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2017-12-10T21:00:00Z",
                "OriginTraffic": 1000,
                "DynamicHttpOriginTraffic": 500,
                "DynamicHttpsOriginTraffic": 500,
                "StaticHttpOriginTraffic": 0,
                "StaticHttpsOriginTraffic": 0
            }
        ]
    },
    "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
    "StartTime": "2017-12-10T20:00:00Z",
    "EndTime": "2017-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 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.