All Products
Search

This Product

    CDN:DescribeRangeDataByLocateAndIspService

    Document Center

    CDN:DescribeRangeDataByLocateAndIspService

    Last Updated:Oct 09, 2025

    You can call DescribeRangeDataByLocateAndIspService to obtain bandwidth data by carrier and region.

    Operation description

    • The time granularity for queries is 5 minutes.

    • The call frequency is limited to 20 calls per second for a single user.

    Supported time granularities

    The maximum time span for a single query, the time range of historical data that you can query, and data latency vary based on the time granularity. The details are as follows:

    Time granularityMaximum time span for a single queryQueryable time range for historical dataData latency
    5 minutes1 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

    cdn:DescribeRangeDataByLocateAndIspService

    none

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainNames

    string

    Yes

    The accelerated domain name.

    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.

    2019-11-30T05:33: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 time range between the end time and the start time cannot exceed 1 hour.

    2019-11-30T05:40:00Z
    IspNames

    string

    No

    The name of the carrier. You can specify only one carrier at a time.

    To query carrier names, call the DescribeCdnRegionAndIsp operation.

    unicom
    LocationNames

    string

    No

    The name of the region. Separate multiple region names with commas (,).

    To query region names, call the DescribeCdnRegionAndIsp operation.

    liaoning,guangxi

    Response elements

    Element

    Type

    Description

    Example

    object

    JsonResult

    string

    The response in the JSON format. The data fields are returned in the following order: UNIX timestamp, region, carrier, distribution of HTTP status codes, response time, bandwidth in bps, average response rate, page views, cache hit ratio, and request hit ratio.

    Important The hit rate is not calculated by region or carrier. A value of 0 is returned for the hit rate.

    {"1472659200":{"天津市":{"电信":{"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}}}}
    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    Examples

    Success response

    JSON format

    {
  "JsonResult": "{\"1472659200\":{\"天津市\":{\"电信\":{\"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}}}}",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    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. Start time and end time do not match, time span limit is exceeded, or the time parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.