DescribeVodDomainBpsData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the bandwidth for one or more specified domain names for CDN.

Operation description

If you specify neither the StartTime parameter nor the EndTime parameter, the data in the last 24 hours is queried. Alternatively, you can specify both the StartTime and EndTime parameters to query data that is generated in the specified duration. You can query data for the last 90 days at most.

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 domain name to be queried. If you do not specify this parameter, the merged data of all your domain names for CDN is returned. You can specify multiple domain names. Separate them with commas (,).	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. Note The minimum query interval is 5 minutes. If you do not specify this parameter, the data in the last 24 hours is queried.	2015-12-10T13: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 ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2015-12-10T14:00:00Z
Interval	string	No	The query interval. Unit: seconds. Valid values: 300, 3600, and 86400. If the time range to query is less than 3 days, valid values are 300, 3600, and 86400. The default value is 300. If the time range to query is from 3 to less than 31 days, valid values are 3600 and 86400. The default value is 3600. If the time range to query is from 31 to 90 days, the valid value is 86400.	300
IspNameEn	string	No	The name of the Internet service provider (ISP). If you do not specify this parameter, the data of all ISPs is returned.	Alibaba
LocationNameEn	string	No	The name of the region. If you do not specify this parameter, the data in all regions is returned. Only data in the China (Shanghai) region can be queried.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T14:00:00Z
StartTime	string	The beginning of the time range in which data was queried. 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
RequestId	string	The ID of the request.	3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F
IspNameEn	string	The name of the ISP. By default, the data of all ISPs is returned.	Alibaba
LocationNameEn	string	The name of the region. By default, the data in all regions is returned.	cn-shanghai
DomainName	string	The domain name for CDN.	example.com
DataInterval	string	The time interval between the returned entries. Unit: seconds.	300
BpsDataPerInterval	array<object>	The bandwidth data that is collected for each 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

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation
2023-05-06	The Error code has changed	View Change Details

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
InvalidStartTime.Malformed	Specified StartTime is malformed.	400	The error message returned because the format of the start time is invalid.
InvalidEndTime.Malformed	Specified EndTime is malformed.	400	The error message returned because the format of the end time is invalid.
InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	400	The error message returned because the time range that is specified by the EndTime and StartTime parameters exceeds 90 days.
InvalidEndTime.Mismatch	Specified EndTime does not math the specified StartTime.	400	The error message returned because the end time is earlier than the start time.