PurgeCaches - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Purges resources cached on points of presence (POPs). You can purge the cache by file URL, directory, cache tag, hostname, or URL with specified parameters ignored, or purge all the cache.

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:PurgeCaches	create	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	Site ID, which can be obtained by calling the ListSites interface.	123456789****
Type	string	Yes	The type of refresh task. Possible values: file (default): File refresh. cachekey: Cachekey refresh. cachetag: Cachetag refresh. directory: Directory refresh. ignoreParams: Ignore parameters refresh. Ignoring parameters means removing the ? and everything after it in the request URL. When performing an ignore parameters refresh, the user first submits the URL without parameters through the interface. The submitted URLs to be refreshed will then be matched against the cached resource URLs with the parameters removed. If the cached resource URL, after removing the parameters, matches the URL to be refreshed, the CDN node will refresh the cached resources. hostname: Hostname refresh. purgeall: Purge all cache under the site.	file
Content	object	No	Content to be refreshed.
Files	array	No	List of files to be refreshed, required when the type is file.
	any	No	List of files to be refreshed, required when the type is file. Note Up to 1000 items per request, and up to 10 different domains.	["http://a.com/1.jpg?b=1", "http://a.com/2.jpg?b=1"]
CacheTags	array	No	List of cachetags to be refreshed, required when the type is cachetag.
	string	No	List of cachetags to be refreshed, required when the type is cachetag. Note Up to 30 items per request.	["tag1", "tag2"]
Hostnames	array	No	List of hostnames to be refreshed, required when the type is hostname.
	string	No	List of hostnames to be refreshed, required when the type is hostname. Note Up to 10 domains per request.	["a.com", "b.com"]
IgnoreParams	array	No	List of files with ignored parameters, required when the type is ignoreParams.
	string	No	List of files with ignored parameters, required when the type is ignoreParams. Note Up to 100 items per request, and up to 10 different domains.	["http://a.com/1.jpg", "http://a.com/2.jpg"]
Directories	array	No	List of directories to be refreshed, required when the type is directory.
	string	No	List of directories to be refreshed, required when the type is directory. Note Up to 100 items per request, and up to 10 different domains.	["http://a.com/path1/", "http://a.com/path2/"]
PurgeAll	boolean	No	Flag for purging all content. Default is false, set to true when the type is purgeall.	true
CacheKeys	array<object>	No	List of cachekeys to be refreshed, required when the type is cachekey.
	object	No
Url	string	No	URL address to be refreshed.	http://a.com/1.jpg?b=1
Headers	object	No	When refreshing, specify the header information corresponding to the cache key. When the custom cache key feature switch is enabled, the cache key will be generated based on the specified header for refreshing. UserGeo: Country/Region Country/region codes follow the ISO 3166-2 standard. UserDeviceType: Device Type, currently there are three enum values desktop tablet mobile UserLanguage: Language Language codes follow the ISO 639-1 or BCP47 standards. For example, input 'zh' to refresh content in Chinese.
	string	No	The value information corresponding to the cachekey header.	{"Url":"http://www.example.com/dog_picture.jpg","Headers":{"cat": "789", "Cookie": "test444=444;test333=333;test222=222", "UserGeo": "US", "UserDeviceType": "desktop","UserLanguage": "zh-CN"}}
Force	boolean	No	Indicates whether to refresh all resources under the directory when the content from the origin and the source resource are inconsistent. The default is false. true: Refreshes all resources under the specified directory. false: Refreshes only the changed resources under the specified directory. Note Applies to: Directory refresh, cachetag refresh, ignoreParams refresh, hostname refresh, and purge all cache of the site.	true
EdgeComputePurge	boolean	No	Used for refreshing cached resources in edge computing, such as allowing the refresh of content cached using the CacheAPI interface of an edge function.	true

Response parameters

Parameter	Type	Description	Example
	object	Schema of the response
RequestId	string	Request ID.	ET5BF670-09D5-4D0B-BEBY-D96A2A528000
TaskId	string	Task ID, which is returned when you create a refresh or preheat task.	15940956620

Examples

Sample success responses

JSONformat

{
  "RequestId": "ET5BF670-09D5-4D0B-BEBY-D96A2A528000",
  "TaskId": 15940956620
}

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.
400	QuotaExceeded	You attempts have exceeded the daily limit.	Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.
429	TooManyRequests	System load fluctuates, please try again later.	System load fluctuates, please try again later.

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

Change history

Change time	Summary of changes	Operation
2025-03-13	The Error code has changed	View Change Details
2025-02-10	The Error code has changed	View Change Details
2024-12-06	The Error code has changed	View Change Details
2024-10-15	The Error code has changed	View Change Details