Use DescribeVodDomainTrafficData to query historical traffic data for accelerated domain names - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Invokes this operation to query the traffic data of an accelerated domain name. Compared with the DescribeVodDomainRealTimeTrafficData operation, this operation supports a longer historical data query range (up to 366 days) but provides a larger data time granularity (minimum of 5 minutes) and higher data latency.

Operation description

The service address of this operation supports only China (Shanghai).
Batch queries are supported. You can query data for up to 500 domain names at a time.
If you do not specify StartTime and EndTime, data of the last 24 hours is returned by default. If you specify StartTime and EndTime, data of the specified time range is returned.

Data time granularity of returned data

The following table describes the default data time granularity of returned data, the queryable historical data range, and the data latency based on the time span specified by StartTime and EndTime when Interval is not set:

Time granularity	Time span per query	Queryable historical data range	Data latency
5 minutes	Time span per query < 3 days	93 days	15 minutes
1 hour	3 days ≤ Time span per query < 31 days	186 days	Typically 3 to 4 hours
1 day	31 days ≤ Time span per query ≤ 366 days	366 days	Typically 4 hours, up to 24 hours

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribeVodDomainTrafficData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by default. Batch queries are supported. Separate multiple domain names with commas (,). You can specify up to 500 domain names at a time. You can log on to the ApsaraVideo VOD console, and choose Configuration Management > CDN Configuration > Domain Names in the left-side navigation pane to view the accelerated domain names that you have added to ApsaraVideo VOD. You can also invoke the DescribeVodUserDomains operation to query the list of accelerated domain names.	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-01-20T13:59:58Z
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-01-20T14:59:58Z
Interval	string	No	The time granularity of the data entries. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or specify an unsupported value, the default value is used. The supported time granularity varies based on the time span specified by `StartTime` and `EndTime`: Less than 3 days (exclusive): 300 (default), 3600, and 86400. 3 to 31 days (exclusive): 3600 (default) and 86400. 31 days or more: 86400 (default).	300
IspNameEn	string	No	The name of the Internet service provider (ISP) in English. If you do not specify this parameter, data of all ISPs is queried by default.	unicom
LocationNameEn	string	No	The name of the region in English. If you do not specify this parameter, data of all regions is queried by default. Only the Shanghai region is supported.	shanghai

Response elements

Element	Type	Description	Example
	object	The response parameters.
EndTime	string	The end of the time range for the returned data.	2019-01-20T14:59:58Z
StartTime	string	The beginning of the time range for the returned data.	2019-01-20T13:59:58Z
RequestId	string	The request ID.	D94E471F-1A27-442E-552D-D4D2000C****
DomainName	string	The accelerated domain name.	example.com
TotalTraffic	string	The total traffic.	5906662826
DataInterval	string	The time interval between the data entries, which is the time granularity of the data. Unit: seconds.	300
TrafficDataPerInterval	object
DataModule	array<object>	The traffic data for each time interval.
	object	The information about the network traffic.
HttpsDomesticValue	string	The HTTPS traffic on L1 nodes in the Chinese mainland. Unit: bytes.	0
Value	string	The total traffic. Unit: bytes.	0
OverseasValue	string	The traffic outside the Chinese mainland. Unit: bytes.	0
HttpsValue	string	The total HTTPS traffic on L1 nodes. Unit: bytes.	0
HttpsOverseasValue	string	The HTTPS traffic on L1 nodes outside the Chinese mainland. Unit: bytes.	0
TimeStamp	string	The data timestamp. The time follows the ISO 8601 standard and is displayed in UTC.	2019-01-20T13:59:58Z
DomesticValue	string	The traffic in the Chinese mainland. Unit: bytes.	0

Examples

Success response

JSON format

{
  "EndTime": "2019-01-20T14:59:58Z",
  "StartTime": "2019-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "TotalTraffic": "5906662826",
  "DataInterval": "300\n",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "0",
        "Value": "0",
        "OverseasValue": "0",
        "HttpsValue": "0",
        "HttpsOverseasValue": "0",
        "TimeStamp": "2019-01-20T13:59:58Z",
        "DomesticValue": "0"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Both start time and end must be specified
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	End time is earlier than start time
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.