All Products
Search
Document Center

Edge Security Acceleration:UpdateCacheRule

Last Updated:Mar 20, 2025
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.

Modify cache configuration

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:UpdateCacheRuleupdate
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

Site ID, which can be obtained by calling the ListSites interface.

123456****
ConfigIdlongYes

Configuration ID.

35281609698****
RuleNamestringNo

Rule name. This parameter is not required when adding a global configuration.

rule_example
RuleEnablestringNo

Rule switch. This parameter is not required when adding a global configuration. Value range:

  • on: Enable.
  • off: Disable.
on
RulestringNo

Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:

  • Match all incoming requests: Set the value to true
  • Match specific requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")
(http.host eq \"video.example.com\")
BypassCachestringNo

Set bypass cache mode. Value range:

  • cache_all: Cache all requests.
  • bypass_all: Bypass cache for all requests.
cache_all
BrowserCacheModestringNo

Browser cache mode. Value range:

  • no_cache: Do not cache.
  • follow_origin: Follow origin cache policy.
  • override_origin: Override origin cache policy.
no_cache
BrowserCacheTtlstringNo

Browser cache expiration time, in seconds.

300
EdgeCacheModestringNo

Edge cache mode. Value range:

  • follow_origin: Follow origin cache policy (if exists), otherwise use the default cache policy.
  • no_cache: Do not cache.
  • override_origin: Override origin cache policy.
  • follow_origin_bypass: Follow origin cache policy (if exists), otherwise do not cache.
follow_origin
EdgeCacheTtlstringNo

Edge cache expiration time, in seconds.

300
EdgeStatusCodeCacheTtlstringNo

Status code cache expiration time, in seconds.

300
SortQueryStringForCachestringNo

Query string sorting. Value range:

  • on: Enable.
  • off: Disable.
on
QueryStringModestringNo

The processing mode of query strings when generating cache keys. Values:

  • ignore_all: Ignore all.
  • exclude_query_string: Exclude specified query strings.
  • reserve_all: Default, reserve all.
  • include_query_string: Include specified query strings.
ignore_all
QueryStringstringNo

Query strings to be retained or excluded, supporting multiple values separated by spaces.

example
IncludeHeaderstringNo

Include the specified header names and their values when generating cache keys, supporting multiple values separated by spaces.

headername
IncludeCookiestringNo

Include the specified cookie names and their values when generating cache keys, supporting multiple values separated by spaces.

cookiename
CacheReserveEligibilitystringNo

Cache retention eligibility. Used to control whether user requests bypass the cache retention node when returning to the origin. Value range:

  • bypass_cache_reserve: Requests bypass cache retention.
  • eligible_for_cache_reserve: Eligible for cache retention.
bypass_cache_reserve
CheckPresenceHeaderstringNo

Check if the header exists when generating cache keys, and if it does, add the header name (case-insensitive) to the cache key. Supports multiple header names, separated by spaces.

headername
CheckPresenceCookiestringNo

Check if the cookie exists when generating cache keys, and if it does, add the cookie name (case-insensitive) to the cache key. Supports multiple cookie names, separated by spaces.

cookiename
UserDeviceTypestringNo

When generating cache keys, include the client device type. Value range:

  • on: enabled.
  • off: disabled.
on
UserGeostringNo

Include the client's geographical location when generating the cache key. Value range:

  • on: Enable.
  • off: Disable.
on
UserLanguagestringNo

Include the client's language type when generating the cache key. Value range:

  • on: Enable.
  • off: Disable.
on
ServeStalestringNo

Serve stale cache. When enabled, the node can still use the expired cached files to respond to user requests even if the origin server is unavailable. Value range:

  • on: Enable.
  • off: Disable.
on
AdditionalCacheablePortsstringNo

Enable caching on specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.

8880
CacheDeceptionArmorstringNo

Cache deception defense. Used to defend against web cache deception attacks; only the cache content that passes the validation will be cached. Value range:

  • on: Enable.
  • off: Disable.
on

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Request ID.

36af3fcc-43d0-441c-86b1-428951dc8225

Examples

Sample success responses

JSONformat

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225"
}

Error codes

HTTP status codeError codeError messageDescription
400CanNotSetSequenceNon-regular configuration, you cannot set Sequence parameters.Sequence parameters is not allowed in global configuration.
400CacheReserveSiteExceedLimitThe number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.The number of sites for which the cache reserve instance bindings exceeds the limit.
400CompileRuleErrorRule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
400SiteConfigLengthExceedLimitThe overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
400ConfigConflictsConfiguration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.The parameter uniqueness check failed. Check for duplicate parameter values.
400RuleRegexQuotaCheckFailedWhen configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
400NestedRuleQuotaCheckFailedThe nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
400ArgQuotaCheckFailedThe passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.The current plan does not support the configuration of restricted parameters, please check the input parameters.
400ServiceInvokeFailedThe call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.Failed to call the service. Please try again later or contact customer service for details.
400FunctionConflictThe feature configuration conflicts. Sites with version management enabled cannot configure this feature.The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
400SpecifiedVersionReadOnlyThe specified version number is read-only and cannot be modified.The specified version number is read-only and cannot be modified.
400VersionNotValidThe site does not have version management enabled, or the version number passed in does not exist.The site does not have version management enabled, or the version number passed in does not exist.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
400InvalidParameter.ArgNameInvalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400InvalidParameter.ArgValueInvalid parameter value. Check whether the value format and length meet the requirements.Invalid parameter value. Check whether the value format and length meet the requirements.
400InvalidParameter.ConfigsInvalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
400InstanceNotExistThe instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400LockFailedThe system is handling requests you previously submitted. Try again later.The system is handling requests you previously submitted. Try again later.
400IllegalOperation.VersionManagementThe version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.
400QuotaCheckFailed.VersionManagementInsufficient quota for version management. Contact technical support.Insufficient quota for version management. Contact technical support.
400InvalidConfigIdThe input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.The ConfigId does not exist.
400Instance.NotOnlineYour plan is unavailable due to an overdue payment. Complete the payment first.Your plan is unavailable due to an overdue payment. Complete the payment first.
404SiteNotFoundThe website does not exist or does not belong to you.The website does not exist or does not belong to you.

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