Query bandwidth data by layer via DescribeVodDomainBpsDataByLayer - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

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

Time granularity of returned data

If you specify StartTime and EndTime without configuring Interval, the default time granularity, the maximum time range for historical data queries, and the data delay are as follows:

Time granularity	Time range per query	Maximum time range for historical data queries	Data delay
5 minutes	Time range per query < 3 days	93 days	15 minutes
1 hour	3 days ≤ Time range per query < 31 days	186 days	Typically 3 to 4 hours
1 day	31 days ≤ Time range 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:DescribeVodDomainBpsDataByLayer

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. 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 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. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-01-23T12:35:12Z
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-23T12:40:12Z
Interval	string	No	The time granularity of the data. 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 range 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.	beijing
Layer	string	No	The protocol type. You can specify the protocol type at the network layer or application layer. Default value: all: includes both network layer and application layer Network layer values: IPv4 IPv6 Application layer values: http https quic	IPv4

Response elements

Element	Type	Description	Example
	object
DataInterval	integer	The time interval between each record, which is the time granularity of the data. Unit: seconds.	300
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
BpsDataInterval	object
DataModule	array<object>	The bandwidth data (bps) for each time interval.
	object
Value	number	The peak bandwidth. Unit: bit/s.	75.33
TrafficValue	integer	The total traffic. Unit: bytes.	1000
TimeStamp	string	The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2024-02-08T10:09:19Z

Examples

Success response

JSON format

{
  "DataInterval": 300,
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "BpsDataInterval": {
    "DataModule": [
      {
        "Value": 75.33,
        "TrafficValue": 1000,
        "TimeStamp": "2024-02-08T10:09:19Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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	InvalidStartTime.ValueNotSupported	The specified start time has invalid value.	The start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.