DescribeVodDomainSrcBpsData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries origin bandwidth data for accelerated domain names in ApsaraVideo VOD. The bandwidth is measured in bit/s.

Operation description

This operation is available only in the China (Shanghai) region.
ApsaraVideo VOD stores the origin bandwidth data for 90 days before the data is deleted.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,). If you specify multiple domain names in a request, aggregation results are returned.

Time granularity

The time granularity supported by the Interval parameter varies based on the time range per query specified by using StartTime and EndTime. The following table describes the time period within which historical data is available and the data delay.

Time granularity	Time range per query (days)	Historical data available (days)	Data delay
5 minutes	(0, 3]	93	15 minutes
1 hour	(3, 31]	186	4 hours
1 day	(31, 366]	366	04:00 on the next day

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,). If you specify multiple domain names in a request, aggregation results are returned. If you leave this parameter empty, the origin bandwidth data for all accelerated domain names is queried by default.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If you leave this parameter empty, the origin bandwidth data that is generated in the last 24 hours is queried by default.	2022-04-25T16:00:00Z
EndTime	string	No	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. The time must be in UTC.	2022-04-26T15:59:59Z
Interval	string	No	The time interval between the data entries to return. Unit: seconds. Valid values: 300: 5 minutes 3600: 1 hour 86400: 1 day Note The time granularity supported by the Interval parameter varies based on the time range per query specified by using `StartTime` and `EndTime`. For more information, see the Time granularity section of this topic.	300

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
EndTime	string	The end of the time range during which data was queried.	2022-08-23T02:02:57Z
StartTime	string	The start of the time range during which data was queried.	2022-07-12T16:00:00Z
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-****
DomainName	string	The accelerated domain name.	sample.com
DataInterval	string	The time interval between the entries returned. Unit: seconds.	300
SrcBpsDataPerInterval	object []	Details about the origin bandwidth data returned at each time interval. Unit: bit/s.
Value	string	The bandwidth value at each time interval.	0
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.	2022-08-23T02:02:57Z
HttpsValue	string	The bandwidth values of origin HTTPS requests.	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	see changesets