Query traffic or bandwidth data of accelerated domains by calling DescribeVodDomainUsageData - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries acceleration traffic or bandwidth usage data.

Operation description

Currently, the only supported service region is China (Shanghai).
Batch domain name queries are supported. Separate multiple domain names with commas (,). You can query up to 100 domain names at a time. If this parameter is left empty, data for all domain names under the account is returned.
You can query data for up to the last year. The maximum time span for a single query is 3 months. If the query time range is 1 to 3 days, data is returned at hourly granularity. If the query time range is 4 days or more, data is returned at daily granularity.

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:DescribeVodDomainUsageData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. If this parameter is left empty, the merged data of all accelerated domain names is returned by default. Batch queries are supported. Separate multiple domain names with commas (,).	example.com
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T10:20:00Z
EndTime	string	Yes	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 (UTC).	2015-12-10T12:20:00Z
Field	string	Yes	The data type. Valid values: bps: bandwidth. traf: traffic.	bps
Type	string	No	The type of usage data to retrieve. Valid values: static: static content. dynamic: dynamic content. all: all content.	static
Area	string	No	The region code. Default value: CN (the Chinese mainland). Valid values: CN: the Chinese mainland. OverSeas: outside the Chinese mainland.	CN
Interval	string	No	Forces the retrieval of data at the specified time granularity, in seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). Interval=300: You can query data for up to the last half year. The maximum time span for a single query is 3 days. Interval=3600 or 86400: You can query data for up to the last year. If Interval is not specified: The maximum time span for a single query is 1 month. If the query time range is 1 to 3 days, data is returned at hourly granularity. If the query time range is 4 days or more, data is returned at daily granularity.	300

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T12:20:00Z
Type	string	The data type. Valid values: bps: bandwidth. traf: traffic.	bps
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T10:20:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-****-E0AC3D31693E
Area	string	The usage region.	CN
DomainName	string	The accelerated domain name information.	example.com
DataInterval	string	The time interval between records. Unit: seconds.	300
UsageDataPerInterval	object
DataModule	array<object>	The traffic or bandwidth usage data.
	object
Value	string	The traffic or bandwidth data. Unit: bit/s.	2592.3920000000003
TimeStamp	string	The timestamp of the returned data. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T10:00:00Z

Examples

Success response

JSON format

{
  "EndTime": "2015-12-10T12:20:00Z",
  "Type": "static",
  "StartTime": "2015-12-10T10:20:00Z",
  "RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "2592.3920000000003",
        "TimeStamp": "2015-12-10T10:00:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is not valid.	The specified parameter is invalid.
400	InvalidParameterProduct	The specified parameter Product is invalid.	The value of Product is invalid. Set the parameter based on the parameter description in the official documentation.
400	InvalidParameterArea	The specified parameter Area is invalid.	The value of Area is invalid. Set the parameter based on the parameter description in the API documentation.
400	InvalidParameterField	The specified parameter Field is invalid.	The value of Field is invalid. Set the parameter based on the parameter description in the API documentation.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The start time is in an invalid format.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The end time is in an invalid format.
400	InvalidEndTime.Mismatch	StartTime or EndTime is mismatch.	The start time and end time do not match.
400	InvalidParameterInterval	The specified Interval is invalid.	The specified time granularity is invalid. Specify the time granularity based on the requirements described in the API documentation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.