RefreshDcdnObjectCacheByCacheTag - Edge Security Acceleration

After the cache tag feature is enabled, you can call RefreshObjectCacheByCacheTag to refresh content by specifying cache tags.

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

dcdn:RefreshDcdnObjectCacheByCacheTag

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name.	example.com
CacheTag	string	Yes	The cache tag. Separate multiple tags with commas.	tag1,tag2
Force	boolean	No	Specifies whether to refresh all resources associated with the cache tag, or only the resources that have been updated. The default value is false. true: Refreshes all resources associated with the tag. false: Refreshes only the changed resources associated with the tag.	true

Response parameters

Parameter	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
RefreshTaskId	string	The ID of the refresh task.	17410889914

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "RefreshTaskId": "17410889914"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SingleRequest.OverLimit	A maximum of 1000 URLs are supported for each request.
400	InvalidObjectType.Malformed	The specified ObjectType is invalid.	The ObjectType parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.	The ObjectPath parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidObjectPath.Size.Malformed	The size of ObjectPath is bigger than 1000.
400	QuotaExceeded.Refresh	You've exceeded the prescribed refresh limits.
400	InvalidExtensiveDomain.ValueNotSupported	The specified ExtensiveDomain is not supported.	Wildcard domain names are not supported.
400	QuotaPerMinuteExceeded.Refresh	You tried to refresh too frequently; please try again later.	Refresh requests are submitted too frequently. Try again later.
400	TooMany.Refresh	The refresh queue is full; please try again later.	The maximum number of refresh requests for a domain name has been reached. Try again later.
400	PreloadQueueFull	Preload queue is full, please try again later!
400	InvalidStations.Malformed	The specified Stations is invalid.
400	InvalidParameters	The parameters you provided are invalid.
429	TooManyRequests	Too many requests, please try again later

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.