DescribeVodDomainTrafficData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

You can call this operation to query traffic data for accelerated domain names. Compared to the DescribeVodDomainRealTimeTrafficData operation, this operation supports queries for historical data over a longer time range. You can query data from the last 366 days. However, this operation has a larger time granularity, with a minimum of 5 minutes, and higher data latency.

Operation description

The endpoint for this operation is available only in the China (Shanghai) region.
This operation supports batch queries. You can query data for up to 500 domain names in a single request.
If you do not specify the StartTime and EndTime parameters, data from the last 24 hours is returned by default. If you specify StartTime and EndTime, data within the specified time range is returned.

Data time granularity

If you do not set the Interval parameter, the default time granularity of the returned data is determined by the time range that you specify between StartTime and EndTime. The following table describes the time granularity, the supported time range for historical data queries, and the data latency.

Time granularity	Time span of a single query	Queryable time range for historical data	Data latency
5 minutes	The time span of a single query is less than 3 days	93 days	15 minutes
1 hour	The time span of a single query is greater than or equal to 3 days and less than 31 days	186 days	Usually 3 to 4 hours
1 day	The time span of a single query is greater than or equal to 31 days and less than or equal to 366 days	366 days	Usually 4 hours, but no more than 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 that you want 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 query a maximum of 500 domain names at a time. Log on to the ApsaraVideo VOD console and choose Configuration Management > CDN Configuration > Domain Names in the navigation pane on the left to view the accelerated domain names that are added to ApsaraVideo VOD. You can also call the DescribeVodUserDomains operation to query the list of accelerated domain names.	example.com
StartTime	string	No	The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-01-20T13:59:58Z
EndTime	string	No	The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed 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 to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not set this parameter, or if you set it to an unsupported value, the default value is used. The supported time granularity varies based on the time range specified by `StartTime` and `EndTime`: If the time range is less than 3 days, valid values are 300 (default), 3600, and 86400. If the time range is from 3 to 31 days, valid values are 3600 (default) and 86400. If the time range is more than 31 days, the valid value is 86400 (default).	300
IspNameEn	string	No	The name of the carrier. If you do not set this parameter, data of all carriers is queried.	unicom
LocationNameEn	string	No	The name of the region. If you do not set this parameter, data in all regions is queried. Currently, only the Shanghai region is supported.	shanghai

Response elements

Element	Type	Description	Example
	object	The response.
EndTime	string	The end of the time range.	2019-01-20T14:59:58Z
StartTime	string	The beginning of the time range.	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 two consecutive data entries. This is the time granularity of the data. Unit: seconds.	300
TrafficDataPerInterval	object
DataModule	array<object>	The list of traffic data at each time interval.
	object
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.