DescribeVodDomainSrcBpsData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the bandwidth data during back-to-origin routing for one or more accelerated domain names.

Operation description

This operation is supported only in the China (Shanghai) region.
You can specify a maximum of 500 accelerated domain names.
If you specify neither StartTime nor EndTime, the data of the last 24 hours is queried. You can specify both StartTime and EndTime parameters to query data of a specified time range.

Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay when you do not set Interval.

Time granularity	Time range per query	Historical data available	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	3 to 4 hours
1 day	31 days ≤ Time span of a single query ≤ 366 days	366 days	4 hours in most cases, not more than 24 hours

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vod:DescribeVodDomainSrcBpsData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. If you leave this parameter empty, the merged data of all your accelerated domain names is returned. You can specify a maximum of 500 accelerated domain names. Separate multiple domain names with commas (,).	example.com
StartTime	string	No	The start 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.	2022-04-25T16: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.	2022-04-26T15:59:59Z
Interval	string	No	The time granularity. Unit: seconds. Valid values: 300, 3600, and 86400. If you leave this parameter empty or specify an invalid value, the default value is used. The supported time granularity varies based on the time range specified by `EndTime` and `StartTime`. The following content describes the supported time granularity. Time range per query < 3 days: 300 (default), 3600, and 86400 3 days ≤ Time range per query < 31 days: 3600 (default) and 86400 31 days ≤ Time range per query ≤ 366 days: 86400 (default)	300

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
EndTime	string	The end of the time range.	2022-08-23T02:02:57Z
StartTime	string	The beginning of the time range.	2022-07-12T16:00:00Z
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-****
DomainName	string	The accelerated domain name whose ICP filing status you want to update.	sample.com
DataInterval	string	The time interval at which data is returned, which is the time granularity. Unit: seconds.	300
SrcBpsDataPerInterval	array<object>	The origin bandwidth data at each time interval.
DataModule	object	The origin bandwidth data at each time interval.
Value	string	The total origin bandwidth data. Unit: bit/s.	0
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.	2022-08-23T02:02:57Z
HttpsValue	string	The bandwidth consumed for fetching resources from the origin over HTTPS.	0

Examples

Sample success responses

JSONformat

{
  "EndTime": "2022-08-23T02:02:57Z",
  "StartTime": "2022-07-12T16:00:00Z",
  "RequestId": "25818875-5F78-4A13-BEF6-****",
  "DomainName": "sample.com",
  "DataInterval": "300",
  "SrcBpsDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2022-08-23T02:02:57Z\n",
        "HttpsValue": "0"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2021-11-24	Add Operation	View Change Details