All Products
Search

This Product

    ApsaraVideo VOD:DescribeVodRangeDataByLocateAndIspService

    Document Center

    ApsaraVideo VOD:DescribeVodRangeDataByLocateAndIspService

    Last Updated:Jul 21, 2026

    Queries access data for an accelerated domain name by ISP or region, including bandwidth, average response rate, page views, cache hit ratio, and request hit ratio.

    Operation description

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

    • The maximum time range for a single query (the time range between StartTime and EndTime) is 1 hour.

    Supported time granularities

    Based on the time range specified by StartTime and EndTime, the default data timestamp granularity, queryable historical data range, and data latency are as follows:

    Time granularityTime range per queryQueryable historical data rangeData latency
    5 minutes≤ 1 hour93 days15 minutes

    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:DescribeVodRangeDataByLocateAndIspService

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainName

    string

    Yes

    The accelerated domain name to query.

    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

    Yes

    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.

    2023-05-29T03:50:00Z
    EndTime

    string

    Yes

    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. The maximum time range between the start time and end time is 1 hour.

    2023-05-29T03:55:00Z
    LocationNameEn

    string

    No

    The region name in English. If you do not specify this parameter, data of all regions is queried. Separate multiple region names with commas (,).

    shanghai
    IspNameEn

    string

    No

    The ISP name in English. If you do not specify this parameter, data of all ISPs is queried. You can specify only one ISP for each request.

    unicom

    Response elements

    Element

    Type

    Description

    Example

    object

    JsonResult

    string

    The result in JSON format. From left to right, the fields are: UNIX timestamp, region, ISP, HTTP status code distribution, response duration, bandwidth (unit: bit/s), average response rate, page views, cache hit ratio, and request hit ratio.

    {"1472659200":{"Tianjin":{"China Telecom":{"http_codes":{"000":0,"200":6,"400":0},"rt":4183,"bandwidth":46639,"avg_speed":7773,"pv":6,"hit_rate":0.93,"request_hit_rate":0.66}}}}
    RequestId

    string

    The request ID.

    C74802AA-C277-5A80-BDF2-072B05F119C7

    Examples

    Success response

    JSON format

    {
  "JsonResult": "{\"1472659200\":{\"Tianjin\":{\"China Telecom\":{\"http_codes\":{\"000\":0,\"200\":6,\"400\":0},\"rt\":4183,\"bandwidth\":46639,\"avg_speed\":7773,\"pv\":6,\"hit_rate\":0.93,\"request_hit_rate\":0.66}}}}",
  "RequestId": "C74802AA-C277-5A80-BDF2-072B05F119C7"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidStartTime.Malformed The specified value of parameter StartTime is malformed.
    400 InvalidEndTime.Malformed The specified value of parameter EndTime is malformed.
    400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported.
    400 InvalidTime.ValueNotSupported StartTime or EndTime is miss match.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.