Queries network traffic data of one or more accelerated domain names within a specified time range.

Description

You can call this operation up to 50 times per second per account.

Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. 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

1 minute

1 hour

7 days

5 minutes

5 minutes

3 days

93 days

15 minutes

1 hour

31 days

186 days

4 hours

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 DescribeDcdnDomainRealTimeTrafficData

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

DomainName String Yes example.com

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

StartTime String No 2015-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.

Note If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
EndTime String No 2015-12-10T20:01: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. The end time must be later than the start time.

Note If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.

Response parameters

Parameter Type Example Description
EndTime String 2015-12-10T20:01:00Z

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

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

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

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

The ID of the request.

DomainName String example.com

The accelerated domain name.

DataInterval String 60

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

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

RealTimeTrafficDataPerInterval Array of DataModule

The amount of back-to-origin network traffic returned at each interval.

DataModule
Value String 0

The amount of back-to-origin network traffic.

Note The network traffic is measured in bytes.
TimeStamp String 2015-12-10T20:00:00Z

The timestamp of the data returned.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=DescribeDcdnDomainRealTimeTrafficData&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T20:01:00Z
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDcdnDomainRealTimeTrafficDataResponse>
<DomainName>example.com</DomainName>
<DataInterval>60</DataInterval>
<RealTimeTrafficDataPerInterval>
    <DataModule>
        <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
        <Value>0</Value>
    </DataModule>
    <DataModule>
        <TimeStamp>2015-12-10T20:01:00Z</TimeStamp>
        <Value>0</Value>
    </DataModule>
</RealTimeTrafficDataPerInterval>
<RequestId>A666D44F-19D6-490E-97CF-1A64AB962C57</RequestId>
<StartTime>2015-12-10T20:00:00Z</StartTime>
<EndTime>2015-12-10T20:01:00Z</EndTime>
</DescribeDcdnDomainRealTimeTrafficDataResponse>

JSON format

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

{
  "DomainName" : "example.com",
  "DataInterval" : "60",
  "RealTimeTrafficDataPerInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2015-12-10T20:00:00Z",
      "Value" : "0"
    }, {
      "TimeStamp" : "2015-12-10T20:01:00Z",
      "Value" : "0"
    } ]
  },
  "RequestId" : "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "StartTime" : "2015-12-10T20:00:00Z",
  "EndTime" : "2015-12-10T20:01: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 InvalidStartTime.Malformed The specified StartTime parameter is invalid. The error message returned because the format of the StartTime 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.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.