Call DescribeVodDomainBpsData to query CDN domain bandwidth - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

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

Operation description

Currently, this operation is available only in the China (Shanghai) region.
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, this operation returns data for the past 24 hours by default. If you specify StartTime and EndTime, this operation returns data for the specified time range.

Time granularity of returned data

If you specify StartTime and EndTime without Settings for Interval, the default time granularity of returned data, the queryable historical data time range, and the data latency are as follows:

Time granularity	Time span per query	Queryable historical data time 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	Generally 3-4 hours
1 day	31 days ≤ Time span per query ≤ 90 days	366 days	Generally 4 hours, 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:DescribeVodDomainBpsData

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.	2015-12-10T13:00:00Z
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.	2015-12-10T14:00:00Z
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 span specified by `StartTime` and `EndTime`: Less than 3 days (excluding exactly 3 days): 300 (default), 3600, and 86400. 3 to 31 days (excluding exactly 31 days): 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. Currently, 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.	2015-12-10T14:00:00Z
StartTime	string	The beginning of the time range for the returned data.	2015-12-10T13:00:00Z
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F
IspNameEn	string	The name of the ISP in English.	unicom
LocationNameEn	string	The name of the region in English.	shanghai
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between consecutive data entries, which is the time granularity of the data. Unit: seconds.	300
BpsDataPerInterval	object
DataModule	array<object>	The list of network bandwidth data for each time interval.
	object
HttpsDomesticValue	string	The HTTPS bandwidth on L1 nodes in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.	11286111
Value	string	The bandwidth. Unit: bit/s.	11288111
OverseasValue	string	The bandwidth outside mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.	2000
HttpsValue	string	The total HTTPS bandwidth on L1 nodes. Unit: bit/s.	11288111
HttpsOverseasValue	string	The HTTPS bandwidth on L1 nodes outside mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.	2000
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.	2015-12-10T13:00:00Z
DomesticValue	string	The bandwidth in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.	11286111

Examples

Success response

JSON format

{
  "EndTime": "2015-12-10T14:00:00Z",
  "StartTime": "2015-12-10T13:00:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F",
  "IspNameEn": "Alibaba",
  "LocationNameEn": "cn-shanghai",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "11286111",
        "Value": "11288111",
        "OverseasValue": "2000",
        "HttpsValue": "11288111",
        "HttpsOverseasValue": "2000",
        "TimeStamp": "2015-12-10T13:00:00Z",
        "DomesticValue": "11286111"
      }
    ]
  }
}

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	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	End time is earlier than start time
400	Invalid.IspNameEn	The IspNameEn is invalid.
400	Invalid.LocationNameEn	The LocationNameEn is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.