Monitor CDN Cache Efficiency with DescribeVodDomainHitRateData - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the byte hit ratio (percentage of hit bytes) of an accelerated domain name.

Operation description

Currently, this operation is supported only in the China (Shanghai) region.
Batch queries are supported. You can query data for up to 500 domain names at a time.
If you do not specify StartTime and EndTime, data from the past 24 hours is returned by default. If you specify StartTime and EndTime, data for the specified time range is returned.

Time granularity of returned data

If you specify StartTime and EndTime without setting Interval, the default time granularity, the maximum time range for historical data queries, and the data delay are as follows:

Time granularity	Time span per query	Maximum time range for historical data queries	Data delay
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 ≤ 366 days	366 days	Generally 4 hours, up to 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:DescribeVodDomainHitRateData

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 queries are 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.	2024-01-20T13:59:58Z
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.	2024-01-20T14:59:58Z
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. The supported time granularity varies based on the time span specified by `StartTime` and `EndTime`: 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.	2024-01-20T14:59:58Z
StartTime	string	The beginning of the time range for the returned data.	2024-01-20T13:59:58Z
RequestId	string	The request ID.	D94E471F-1A27-442E-552D-D4D2000C****
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
HitRateInterval	object
DataModule	array<object>	The byte hit ratio data for each time interval.
	object
Value	string	The total byte 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.	2024-01-20T13:59:58Z
HttpsValue	string	The HTTPS byte hit rate.	50

Examples

Success response

JSON format

{
  "EndTime": "2024-01-20T14:59:58Z",
  "StartTime": "2024-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "DataInterval": "300",
  "HitRateInterval": {
    "DataModule": [
      {
        "Value": "100",
        "TimeStamp": "2024-01-20T13:59:58Z",
        "HttpsValue": "50"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Both start time and end must be specified
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	End time is earlier than start time
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.