All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodRangeDataByLocateAndIspService

Last Updated:Sep 26, 2024

Queries the bandwidth data by Internet service provider (ISP) and region.

Operation description

The data is collected every 5 minutes. You can call this API operation up to 20 times per second per account. Time granularity

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

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes1 hour93 days15 minutes

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:DescribeVodRangeDataByLocateAndIspServiceget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name.

example.com
StartTimestringYes

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
EndTimestringYes

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.

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

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

beijing
IspNameEnstringNo

The name of the ISP. If you leave this parameter empty, all ISPs are queried.

unicom

Response parameters

ParameterTypeDescriptionExample
object
JsonResultstring

The returned result. The value is in the JSON format. These parameters indicate the following information in sequence: UNIX time, region, ISP, distribution of HTTP status codes, response time, bandwidth (bit/s), average response rate, page views, cache hit ratio, and request hit ratio.

{"1472659200":{"tianjin":{"unicom":{"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}}}}
RequestIdstring

The ID of the request.

C74802AA-C277-5A80-BDF2-072B05F119C7

Examples

Sample success responses

JSONformat

{
  "JsonResult": "{\"1472659200\":{\"tianjin\":{\"unicom\":{\"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

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