All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainQpsData

Last Updated:Sep 11, 2024

Queries the number of queries per second (QPS) for one or more accelerated domain names. Data is collected every 5 minutes. You can query data collected in the last 90 days.

Operation description

  • This operation is available only in the China (Shanghai) region.
  • You can call this operation up to 100 times per second per account.
  • 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 these parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days3 to 4 hours
1 day366 days366 days4 to 24 hours

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:DescribeVodDomainQpsDataget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

You can specify multiple domain names and separate them with commas (,). You can specify a maximum of 500 domain names in each call.

By default, this operation queries the number and proportions of HTTP status codes for all accelerated domain names that belong to your Alibaba Cloud account.

example.com
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd**THH:mm:ssZ format. The time must be in UTC.

2024-05-02T15:50:00Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd**THH:mm:ssZ format. The time must be in UTC.

2024-05-02T15:59:00Z
IntervalstringNo

The interval at which to return data. Unit: seconds. Valid values: 300, 3600, and 86400.

300
IspNameEnstringNo

The name of the Internet service provider (ISP). If you leave this parameter empty, data of all ISPs is queried.

unicom
LocationNameEnstringNo

The name of the region. If you leave this parameter empty, data in all regions is queried.

beijing

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried. The time follows the ISO 8601 standard in the YYYY-MM-DD**Thh:mm:ss format. The time is displayed in UTC.

2024-05-02T15:59:00Z
StartTimestring

The beginning of the time range during which data was queried. The time follows the ISO 8601 standard in the YYYY-MM-DD**Thh:mm:ss format. The time is displayed in UTC.

2024-05-02T15:50:00Z
RequestIdstring

The ID of the request.

25818875-5F78-4AF6-D7393642CA58*****
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

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

300
QpsDataIntervalarray<object>

The list of QPS records at each interval.

object
AccValuestring

The total number of requests.

0
AccDomesticValuestring

The number of requests in the Chinese mainland.

0
AccOverseasValuestring

The number of requests outside the Chinese mainland.

0
HttpsValuestring

The QPS that is calculated based on the HTTPS requests sent to points of presence (POPs).

1
HttpsOverseasValuestring

The QPS that is calculated based on the HTTPS requests sent to POPs outside the Chinese mainland.

1
DomesticValuestring

The QPS data in the Chinese mainland.

0
HttpsAccOverseasValuestring

The number of HTTPS requests sent to POPs outside the Chinese mainland.

1
HttpsDomesticValuestring

The QPS that is calculated based on the HTTPS requests sent to POPs in the Chinese mainland.

1
HttpsAccValuestring

The number of HTTPS requests sent to POPs.

1
Valuestring

The total QPS.

0
OverseasValuestring

The QPS data outside the Chinese mainland.

0
TimeStampstring

The timestamp of the data returned. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2023-06-27 10:10:58
HttpsAccDomesticValuestring

The QPS that is calculated based on the HTTPS requests sent to POPs in the Chinese mainland.

1

Examples

Sample success responses

JSONformat

{
  "EndTime": "2024-05-02T15:59:00Z",
  "StartTime": "2024-05-02T15:50:00Z",
  "RequestId": "25818875-5F78-4AF6-D7393642CA58*****",
  "DomainName": "example.com",
  "DataInterval": "300",
  "QpsDataInterval": {
    "DataModule": [
      {
        "AccValue": "0",
        "AccDomesticValue": "0",
        "AccOverseasValue": "0",
        "HttpsValue": "1",
        "HttpsOverseasValue": "1",
        "DomesticValue": "0",
        "HttpsAccOverseasValue": "1",
        "HttpsDomesticValue": "1",
        "HttpsAccValue": "1",
        "Value": "0",
        "OverseasValue": "0",
        "TimeStamp": "2023-06-27 10:10:58",
        "HttpsAccDomesticValue": "1"
      }
    ]
  }
}

Error codes

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