Queries the monitoring data of network traffic for one or more accelerated domain names.

Usage notes

  • The maximum number of times that each user can call this operation per second is 50.
  • If you do not set StartTime or EndTime, data collected within the last hour is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
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

Time range to 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 DescribeDomainRealTimeTrafficData

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

DomainName String Yes example.com

You can specify multiple domain names and separate them with commas (,). You can specify at most 100 domain names in each call.

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

IspNameEn String No telecom

The name of the ISP for your Alibaba Cloud CDN service.

You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions 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 set this parameter, all regions are queried.

EndTime String No 2019-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.

Note The end time must be later than the start time.

Response parameters

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

The end of the time range that was queried.

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

The beginning of the time range that 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 time range to query. Supported values: 60 (1 minute), 300 (5 minutes), and 3600(1 hour). For more information, see the usage notes.

RealTimeTrafficDataPerInterval Array of DataModule

The amount of network traffic at each time interval. Unit: bytes.

DataModule
Value String 0

The amount of network traffic.

TimeStamp String 2019-12-10T20:01:00Z

The timestamp of the data returned.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainRealTimeTrafficData
&DomainName=example.com
&StartTime=2019-12-10T20:00:00Z
&IspNameEn=telecom
&LocationNameEn=beijing
&EndTime=2019-12-10T20:01:00Z
&Common request parameters

Sample success responses

XML format 

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

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

JSON format 

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

{
  "DomainName" : "example.com",
  "DataInterval" : "60",
  "RealTimeTrafficDataPerInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2019-12-10T20:00:00Z",
      "Value" : "0"
    }, {
      "TimeStamp" : "2019-12-10T20:01:00Z",
      "Value" : "0"
    } ]
  },
  "RequestId" : "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "StartTime" : "2019-12-10T20:00:00Z",
  "EndTime" : "2019-12-10T20:01:00Z"
}

Error codes

HttpCode Error code Error message Description
400 MissingParameter StartTime and EndTime can not be single. The error message returned because both the StartTime and EndTime parameters must be set.
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the format of the specified end time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time must be later than the start time.
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. The error message returned because the specified start time is invalid. Rectify the start time and try again.

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