DescribeVodDomainSrcTrafficData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries origin traffic data for accelerated domain names in ApsaraVideo VOD. The traffic is measured in bytes.

Operation description

This operation is available only in the China (Shanghai) region.
ApsaraVideo VOD stores the origin traffic data for 90 days before the data is deleted.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,). If you specify multiple domain names in a request, aggregation results are returned.

Time granularity

The time granularity supported by the Interval parameter varies based on the time range per query specified by using StartTime and EndTime. The following table describes the time period within which historical data is available and the data delay.

Time granularity	Time range per query (days)	Historical data available (days)	Data delay
5 minutes	(0, 3]	93	15 minutes
1 hour	(3, 31]	186	4 hours
1 day	(31, 366]	366	04:00 on the next day

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vod:DescribeVodDomainSrcTrafficData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,). If you specify multiple domain names in a request, aggregation results are returned. If you leave this parameter empty, the origin traffic data for all accelerated domain names is queried by default.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If you leave this parameter empty, the origin traffic data that is generated in the last 24 hours is queried by default.	2022-03-22T16:00:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-09-24T15:59:59Z
Interval	string	No	The time interval between the data entries to return. Unit: seconds. Valid values: 300: 5 minutes 3600: 1 hour 86400: 1 day Note The time granularity supported by the Interval parameter varies based on the time range per query specified by using `StartTime` and `EndTime`. For more information, see the Time granularity section of this topic.	300

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
EndTime	string	The end of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-09-23T15:59:59Z
StartTime	string	The start of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-08-29T16:00:00Z
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****
DomainName	string	The accelerated domain name.	example.com
TotalTraffic	string	The total traffic. Unit: bytes.	5906662826
DataInterval	string	The time interval between the entries returned. Unit: seconds.	300
SrcTrafficDataPerInterval	array<object>	Details about the origin traffic returned at each time interval. Unit: bytes.
DataModule	object	The amount of origin traffic returned at each time interval.
Value	string	The traffic value at each time interval.	0
TimeStamp	string	The timestamp of the returned data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-09-23T15:59:59Z
HttpsValue	string	The amount of traffic generated by origin HTTPS requests.	0

Examples

Sample success responses

JSONformat

{
  "EndTime": "2022-09-23T15:59:59Z",
  "StartTime": "2022-08-29T16:00:00Z",
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DomainName": "example.com",
  "TotalTraffic": "5906662826",
  "DataInterval": "300",
  "SrcTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2022-09-23T15:59:59Z",
        "HttpsValue": "0"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2021-12-22	Add Operation	View Change Details