All Products
Search

This Product

    ApsaraVideo VOD:DescribeVodDomainRealTimeTrafficData

    Document Center

    ApsaraVideo VOD:DescribeVodDomainRealTimeTrafficData

    Last Updated:Jul 21, 2026

    Invokes this operation to query the traffic data of an accelerated domain name. Compared with the DescribeVodDomainTrafficData operation, this operation supports a smaller time granularity (minimum of 1 minute), lower data latency (minimum of 5 minutes), but a shorter historical data range (up to 186 days).

    Operation description

    • The service address of this operation supports only China (Shanghai).

    • Batch queries are supported. You can query data for up to 100 domain names at a time.

    • If you do not specify StartTime and EndTime, this operation returns data for the last hour by default. If you specify StartTime and EndTime, this operation returns data for the specified time range.

    Time granularity of returned data

    The time granularity of returned data varies based on the time range specified by StartTime and EndTime. The following table describes the queryable historical data range and data latency for each time granularity:

    Time granularityTime range per queryQueryable historical data rangeData latency
    1 minuteTime range per query ≤ 1 hour7 days5 minutes
    5 minutes1 hour < Time range per query < 3 days93 days15 minutes
    1 hour3 days ≤ Time range per query < 31 days186 daysGenerally 3 to 4 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:DescribeVodDomainRealTimeTrafficData

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainName

    string

    Yes

    The accelerated domain name to query.

    • Separate multiple domain names with commas (,). You can specify up to 100 domain names at a time.

    • When you query multiple domain names, the returned data is the aggregated data of all specified domain names.

    • You can log on to the ApsaraVideo VOD console and choose Configuration Management > CDN Configuration > Domain Names in the left-side navigation pane to view the accelerated domain names that you have added to ApsaraVideo VOD. You can also call the DescribeVodUserDomains operation to query the list of accelerated domain names.

    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.

    2019-12-10T20:00:00Z
    EndTime

    string

    No

    The end 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 end time must be later than the start time.

    2019-12-10T20:01:00Z
    IspNameEn

    string

    No

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

    telecom
    LocationNameEn

    string

    No

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

    shanghai

    Response elements

    Element

    Type

    Description

    Example

    object

    EndTime

    string

    The end of the time range for the returned data.

    2019-12-10T20:01:00Z
    StartTime

    string

    The beginning of the time range for the returned data.

    2019-12-10T20:00:00Z
    RequestId

    string

    The request ID.

    A666D44F-19D6-490E-97CF-1A64AB962C57
    DomainName

    string

    The accelerated domain name.

    example.com
    DataInterval

    string

    The time interval between data entries, which is the time granularity of the data. Unit: seconds.

    Based on the time range per query, this parameter returns a fixed value of 60 (1 minute), 300 (5 minutes), or 3600 (1 hour). For more information, see Time granularity of returned data in the operation description.

    60
    RealTimeTrafficDataPerInterval

    object

    DataModule

    array<object>

    The traffic data for each time interval.

    object

    Value

    string

    The traffic data. Unit: bytes.

    0
    TimeStamp

    string

    The timestamp of the data returned. The time follows the ISO 8601 standard. The time is displayed in UTC.

    2019-12-10T20:01:00Z

    Examples

    Success response

    JSON format

    {
  "EndTime": "2019-12-10T20:01:00Z",
  "StartTime": "2019-12-10T20:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2019-12-10T20:01:00Z"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingParameter StartTime and EndTime can not be single.
    400 InvalidStartTime.Malformed Specified StartTime is malformed. The start time is in an invalid format.
    400 InvalidEndTime.Malformed Specified EndTime is malformed. The end time is in an invalid format.
    400 InvalidEndTime.Mismatch Specified end time does not math the specified start time.
    400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported.
    400 Abs.DomainName.Malformed The size of DomainName is too big.
    400 InvalidInterval.Malformed Specified Interval is malformed.
    400 InvalidIspParameter The specified Isp is invalid.
    400 InvalidLocName The specified LocName is not supported.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.