Use DescribeVodDomainReqHitRateData to query request hit ratio - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the request hit ratio (percentage of hit requests) of an accelerated domain name.

Operation description

Currently, this operation supports only the following service address: China (Shanghai).
Batch query is supported. You can query data of up to 500 domain names at a time.
If you do not specify StartTime and EndTime, this operation returns data of the last 24 hours by default. If you specify StartTime and EndTime, this operation returns data of the specified time range.

Time granularity of returned data

Based on the time span specified by StartTime and EndTime, and when Interval is not set, the default time granularity of returned data, the queryable historical data time range, and data latency are as follows:

Time granularity	Time span per query	Queryable historical data time range	Data latency
5 minutes	Time span per query < 3 days	93 days	15 minutes
1 hour	3 days ≤ Time span per query < 31 days	186 days	Generally 3 to 4 hours
1 day	31 days ≤ Time span per query ≤ 90 days	366 days	Generally 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:DescribeVodDomainReqHitRateData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by default. Batch query is supported. Separate multiple domain names with commas (,). You can specify up to 500 domain names at a time. 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.	2023-12-21T08: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.	2023-12-22T08:00:00Z
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or specify an unsupported value, the default value is used. Based on the time span specified by `StartTime` and `EndTime`, the supported time granularity is as follows: Less than 3 days (exclusive): 300 (default), 3600, and 86400. 3 to 31 days (exclusive): 3600 (default) and 86400. 31 days or more: 86400 (default).	300

Response elements

Element	Type	Description	Example
	object	The response parameters.
EndTime	string	The end of the time range for the returned data.	2023-12-22T08:00:00Z
RequestId	string	The request ID.	D94E471F-1A27-442E-552D-D4D2000C****
Data	object
DataModule	array<object>	The list of request hit ratio data for each time interval.
	object
Value	string	The total request hit rate.	100
TimeStamp	string	The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2023-12-21T08:00:00Z
HttpsValue	string	The HTTPS request hit rate.	50
StartTime	string	The beginning of the time range for the returned data.	2023-12-21T08:00:00Z
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.	300

Examples

Success response

JSON format

{
  "EndTime": "2023-12-22T08:00:00Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "Data": {
    "DataModule": [
      {
        "Value": "100",
        "TimeStamp": "2023-12-21T08:00:00Z",
        "HttpsValue": "50"
      }
    ]
  },
  "StartTime": "2023-12-21T08:00:00Z",
  "DomainName": "example.com",
  "DataInterval": "300"
}

Error codes

HTTP status code	Error code	Error message
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.