DescribeRefreshQuota - CDN - Alibaba Cloud Documentation Center

DescribeRefreshQuota

Operation description

Queries the maximum and remaining numbers of URLs and directories that can be refreshed, the maximum and remaining numbers of times that you can prefetch content, and the maximum and remaining numbers of URLs and directories that can be blocked on the current day.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
cdn:DescribeRefreshQuota	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
PreloadRemain	string	The maximum number of times that you can prefetch content to L1 nodes on the current day.	400
BlockRemain	string	The remaining number of times that you can prefetch content to L2 points of presence (POPs) on the current day.	100
RegexRemain	string	The remaining number of URLs that can be blocked on the current day.	10
UrlRemain	string	The remaining number of URLs or directories that can be refreshed by using regular expressions on the current day.	1996
DirRemain	string	The remaining number of URLs that can be refreshed on the current day.	99
UrlQuota	string	The remaining number of directories that can be refreshed on the current day.	2000
BlockQuota	string	The maximum number of URLs that can be refreshed on the current day.	300
RequestId	string	The maximum number of URLs and directories that can be blocked on the current day.	42E0554B-80F4-4921-AED6-ACFB22CAAAD0
DirQuota	string	The ID of the request.	100
PreloadEdgeQuota	string	The maximum number of directories that can be refreshed on the current day.	20
PreloadEdgeRemain	string	The maximum number of times that you can prefetch content to L1 POPs on the current day.	20
PreloadQuota	string	The remaining number of times that you can prefetch content to L1 POPs on the current day.	500
RegexQuota	string	The maximum number of times that you can prefetch content to L2 POPs on the current day.	20
IgnoreParamsQuota	string	The maximum number of URLs or directories with parameters ignored that can be refreshed on the current day.	100
IgnoreParamsRemain	string	The number of remaining URLs or directories that can be refreshed with parameters ignored on the current day.	10

Examples

Sample success responses

JSONformat

{
  "PreloadRemain": "400",
  "BlockRemain": "100",
  "RegexRemain": "10",
  "UrlRemain": "1996",
  "DirRemain": "99",
  "UrlQuota": "2000",
  "BlockQuota": "300",
  "RequestId": "42E0554B-80F4-4921-AED6-ACFB22CAAAD0",
  "DirQuota": "100",
  "PreloadEdgeQuota": "20",
  "PreloadEdgeRemain": "20",
  "PreloadQuota": "500",
  "RegexQuota": "20",
  "IgnoreParamsQuota": "100",
  "IgnoreParamsRemain": "10"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-03-29	The response structure of the API has changed	View Change Details