All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainBpsData

Last Updated:Nov 09, 2022

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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:DescribeVodDomainBpsDataRead
  • VOD
    acs:vod:*:{#accountId}:*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

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
StartTimestringNo

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.

NoteThe 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
EndTimestringNo

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
IntervalstringNo

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
IspNameEnstringNo

The name of the Internet service provider (ISP). If you do not specify this parameter, the data of all ISPs is returned.

Alibaba
LocationNameEnstringNo

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

ParameterTypeDescriptionExample
object
EndTimestring

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
StartTimestring

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
RequestIdstring

The ID of the request.

3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F
IspNameEnstring

The name of the ISP. By default, the data of all ISPs is returned.

Alibaba
LocationNameEnstring

The name of the region. By default, the data in all regions is returned.

cn-shanghai
DomainNamestring

The domain name for CDN.

example.com
DataIntervalstring

The time interval between the returned entries. Unit: seconds.

300
BpsDataPerIntervalarray

The bandwidth data that is collected for each interval.

object
HttpsDomesticValuestring

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
Valuestring

The bandwidth. Unit: bit/s.

11288111
OverseasValuestring

The bandwidth outside mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

2000
HttpsValuestring

The total HTTPS bandwidth on L1 nodes. Unit: bit/s.

11288111
HttpsOverseasValuestring

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
TimeStampstring

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
DomesticValuestring

The bandwidth in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

11286111

Example

Normal return example

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": [
    {
      "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 API error center.

Common errors

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

Error codeError messageHTTP status codeDescription
InvalidStartTime.MalformedSpecified StartTime is malformed.400The error message returned because the format of the start time is invalid.
InvalidEndTime.MalformedSpecified EndTime is malformed.400The error message returned because the format of the end time is invalid.
InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.400The error message returned because the time range that is specified by the EndTime and StartTime parameters exceeds 90 days.
InvalidEndTime.MismatchSpecified EndTime does not math the specified StartTime.400The error message returned because the end time is earlier than the start time.