GetPurgeQuota - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the quotas and quota usage for different cache purge options.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
esa:GetPurgeQuota	get	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	No	The website ID. You can call the ListSites operation to obtain the ID.	123456789****
Type	string	No	The type of the purge task. Valid values: file (default): purges the cache by file. cachetag: purges the cache by cache tag. directory: purges the cache by directory. ignoreParams: purges the cache by URL with specific parameters ignored. hostname: purges the cache by hostname. purgeall: purges all cache.	file

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
Quota	string	The total quota.	100000
Usage	string	The quota usage.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Quota": 100000,
  "Usage": 10
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Please provide both a start time and an end time.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.
400	InvalidTime	The query time cannot exceed the last 3 days.	The query time cannot exceed the last 3 days.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	Specify the ObjectType parameter.
400	InvalidStationParameter	The specified Station is invalid.	The specified node parameter is invalid.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	InvalidTaskId.Malformed	The specified taskId is invalid.	The specified task ID is invalid.
400	InvalidParameters.InvalidUrls	The specified urls are invalid.	The requested URL parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2025-02-10	The Error code has changed	View Change Details