All Products
Search

This Product

    ApsaraVideo VOD:DescribeVodDomainQpsData

    Document Center

    ApsaraVideo VOD:DescribeVodDomainQpsData

    Last Updated:Jul 21, 2026

    Queries the queries per second (QPS) of accelerated domain names at a 5-minute granularity. Data from the last 90 days is supported.

    Operation description

    • Currently, this operation is supported only in the China (Shanghai) region.

    • Maximum call frequency per user: 100 calls per second.

    • If you do not specify StartTime and EndTime, this operation returns data from the last 24 hours. If you specify StartTime and EndTime, this operation returns data for the specified time range.

    Supported time granularities

    The Interval request parameter supports different data time granularities based on the maximum time range per query. The following table describes the queryable historical data time range and data latency for each time granularity:

    Time granularityMaximum time range per queryQueryable historical data time rangeData latency
    5 minutes3 days93 days15 minutes
    1 hour31 days186 daysTypically 3-4 hours
    1 day366 days366 daysTypically 4 hours, no more than 24 hours

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    vod:DescribeVodDomainQpsData

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainName

    string

    No

    The accelerated domain names. Separate multiple domain names with commas (,). You can specify up to 500 domain names in a single request.

    By default, all accelerated domain names are queried.

    example.com
    StartTime

    string

    No

    The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

    string

    No

    The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

    string

    No

    The time granularity of the queried data. Unit: seconds. Valid values: 300, 3600, and 86400.

    300
    IspNameEn

    string

    No

    The name of the Internet service provider (ISP). Default value: all ISPs.

    unicom
    LocationNameEn

    string

    No

    The name of the region. If you do not specify this parameter, all regions are queried.

    beijing

    Response elements

    Element

    Type

    Description

    Example

    object

    EndTime

    string

    The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

    string

    The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

    string

    The request ID.

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

    string

    The accelerated domain name.

    example.com
    DataInterval

    string

    The time interval between entries. Unit: seconds.

    300
    QpsDataInterval

    object

    DataModule

    array<object>

    The QPS data for each time interval.

    object

    The QPS for each time interval.

    AccValue

    string

    The total number of requests.

    0
    AccDomesticValue

    string

    The number of requests in the Chinese mainland.

    0
    AccOverseasValue

    string

    The number of requests outside the Chinese mainland.

    0
    HttpsValue

    string

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

    1
    HttpsOverseasValue

    string

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

    1
    DomesticValue

    string

    The QPS data in the Chinese mainland.

    0
    HttpsAccOverseasValue

    string

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

    1
    HttpsDomesticValue

    string

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

    1
    HttpsAccValue

    string

    The number of HTTPS requests sent to POPs.

    1
    Value

    string

    The total QPS.

    0
    OverseasValue

    string

    The QPS data outside the Chinese mainland.

    0
    TimeStamp

    string

    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
    HttpsAccDomesticValue

    string

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

    1

    Examples

    Success response

    JSON format

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

    HTTP status code

    Error code

    Error message

    Description
    400 MissingTimeParameter The StartTime and EndTime must be both specified. Both start time and end must be specified
    400 InvalidStartTime.Malformed The specified StartTime is invalid.
    400 InvalidEndTime.Malformed The specified EndTime is invalid.
    400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. End time is earlier than start time
    400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.