DescribeVodDomainRealTimeTrafficData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the traffic data for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. Compared with the DescribeVodDomainTrafficData operation, this operation provides a smaller time granularity, lower data latency, and allows you to query historical data within a shorter time period.

Operation description

This operation is supported only in the China (Shanghai) region.
You can specify a maximum of 100 accelerated domain names.
If you specify neither StartTime nor EndTime, the data of the last 1 hour is queried. You can specify both StartTime and EndTime parameters to query data of a specified time range.

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 per query	Historical data available	Data delay
1 minute	Time range per query ≤ 1 hour	7 days	5 minutes
5 minutes	1 Hour < Time range per query ≤ 3 days	93 days	15 minutes
1 hour	3 days < Time range per query ≤ 31 days	186 days	3 to 4 hours

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	You can specify multiple domain names and separate them with commas (,). You can specify a maximum of 500 domain names in each call.	example.com
StartTime	string	No	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.	2019-12-10T20:00:00Z
EndTime	string	No	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.	2019-12-10T20:01:00Z
IspNameEn	string	No	The name of the ISP. If you do not set this parameter, all ISPs are queried.	telecom
LocationNameEn	string	No	The name of the region. If you do not set this parameter, data in all regions is queried.	shanghai

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range.	2019-12-10T20:01:00Z
StartTime	string	The beginning of the time range.	2019-12-10T20:00:00Z
RequestId	string	The ID of the request.	A666D44F-19D6-490E-97CF-1A64AB962C57
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval at which data is returned. Unit: seconds. The returned value varies based on the time range per query. Valid values: 60 (1 minute), 300 (5 minutes), and 3600 (1 hour). For more information, see the Time granularity section in the API documentation.	60
RealTimeTrafficDataPerInterval	array<object>	The details of traffic data in each time interval.
	object
Value	string	The traffic data. Unit: bytes.	0
TimeStamp	string	The timestamp of the data returned. The time follows the ISO 8601 standard. The time is displayed in UTC.	2019-12-10T20:01:00Z

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.