DescribeVodRefreshQuota - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the maximum number and remaining number of requests to refresh or prefetch files on the current day. You can prefetch files based on URLs and refresh files based on URLs or directories.

Operation description

Note

This operation is available only in the China (Shanghai) region.

You can call the RefreshVodObjectCaches operation to refresh content and the PreloadVodObjectCaches operation to prefetch content.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:DescribeVodRefreshQuota	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
BlockQuota	string	The maximum number of Object Storage Service (OSS) buckets that can be refreshed each day.	500
PreloadRemain	string	The remaining number of URLs of files that can be prefetched on the current day.	500
RequestId	string	The ID of the request.	42E0554B-80F4-4921-****-ACFB22CAAAD0
blockRemain	string	The remaining number of OSS buckets that can be refreshed on the current day.	500
DirRemain	string	The remaining number of directories of files that can be refreshed on the current day.	99
UrlRemain	string	The remaining number of URLs of files that can be refreshed on the current day.	1996
DirQuota	string	The maximum number of directories of files that can be refreshed each day.	100
UrlQuota	string	The maximum number of URLs of files that can be refreshed each day.	2000
PreloadQuota	string	The maximum number of URLs of files that can be prefetched each day.	500

Examples

Sample success responses

JSONformat

{
  "BlockQuota": "500",
  "PreloadRemain": "500",
  "RequestId": "42E0554B-80F4-4921-****-ACFB22CAAAD0",
  "blockRemain": "500",
  "DirRemain": "99",
  "UrlRemain": "1996",
  "DirQuota": "100",
  "UrlQuota": "2000",
  "PreloadQuota": "500"
}

Error codes

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

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
Throttling	Request was denied due to request throttling.	503	The error message returned because the request was denied due to throttling.
OperationDenied	Your account does not open VOD service yet.	403	The error message returned because ApsaraVideo VOD has not been activated for your Alibaba Cloud account.
OperationDenied.Suspended	Your VOD service is suspended.	403	The error message returned because your Alibaba Cloud account has overdue payments. Add funds to your account.