Edge Security Acceleration:ListCacheRules

The configuration ID.

The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.

The rule execution order. A smaller value indicates a higher priority.

The rule switch. You do not need to set this parameter when you add a global configuration. Valid values:

• on: enabled.

• off: disabled.

The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when you add a global configuration. Two scenarios are supported:

• Match all incoming requests: set the value to true.

• Match specified requests: set the value to a custom expression, such as (http.host eq "video.example.com").

The rule name. You do not need to set this parameter when you add a global configuration.

The configuration type. You can use this parameter to query global or rule configurations. Valid values:

• global: global configuration.

• rule: rule configuration.

The bypass cache mode. Valid values:

• cache_all: caches all requests.

• bypass_all: bypasses cache for all requests.

The browser cache mode. Valid values:

• no_cache: does not cache.

• follow_origin: follows the origin cache policy.

• override_origin: overrides the origin cache policy.

The browser cache expiration time, in seconds.

The edge cache mode. Valid values:

• follow_origin: follows the origin cache policy if present. Otherwise, uses the default cache policy.

• no_cache: does not cache.

• override_origin: overrides the origin cache policy.

• follow_origin_bypass: follows the origin cache policy if present. Otherwise, does not cache.

• follow_origin_override: follows the origin cache policy if present. Otherwise, uses a custom cache TTL.

The edge cache expiration time, in seconds.

The status code cache expiration time, in seconds.

• You can set the cache expiration time for specific status codes. For example, 404=10 indicates that the 404 status code is cached for 10 seconds.

• You can set the cache expiration time for 4xx or 5xx series status codes. For example, 4xx=10 indicates that all 4xx status codes are cached for 10 seconds.

• You can set the cache expiration time for multiple status codes. Separate multiple status codes with commas (,).

Specifies whether to sort query strings. Valid values:

• on: enabled.

• off: disabled.

The query string handling mode when generating cache keys. Valid values:

• ignore_all: ignores all query strings.

• exclude_query_string: removes specified query strings.

• reserve_all: retains all query strings. This is the default value.

• include_query_string: retains specified query strings.

The query strings to retain or remove when generating cache keys. Multiple values are separated by spaces.

The specified header names (case-insensitive) and their values to include when generating cache keys. Multiple values are separated by spaces. Header names support the following character types:

• Symbols: ! # $ % & ' * + - . ^ _ ` | ~

• Digits: 0-9

• Letters: lowercase a-z.

The specified cookie names (case-insensitive) and their values to include when generating cache keys. Multiple values are separated by spaces. Cookie names support the following character types:

• Symbols: ! # $ % & ' * + - . ^ _ ` | ~

• Digits: 0-9

• Letters: lowercase a-z.

The cache reserve eligibility. Controls whether user requests bypass the cache reserve node during back-to-origin. Valid values:

• bypass_cache_reserve: requests bypass cache reserve.

• eligible_for_cache_reserve: requests are eligible for cache reserve.

When generating cache keys, checks whether the specified headers exist. If a header exists, its name (case-insensitive) is added to the cache key. Multiple header names are separated by spaces. Header names support the following character types:

• Symbols: ! # $ % & ' * + - . ^ _ ` | ~

• Digits: 0-9

• Letters: lowercase a-z.

When generating cache keys, checks whether the specified cookies exist. If a cookie exists, its name (case-insensitive) is added to the cache key. Multiple cookie names are separated by spaces. Cookie names support the following character types:

• Symbols: ! # $ % & ' * + - . ^ _ ` | ~

• Digits: 0-9

• Letters: lowercase a-z.

Specifies whether to include the type of the client when generating cache keys. Valid values:

• on: enabled.

• off: shutdown.

Specifies whether to include the client geographic location when generating cache keys. Valid values:

• on: enabled.

• off: disabled.

Specifies whether to include the client language type when generating cache keys. Valid values:

• on: enabled.

• off: disabled.

Specifies whether to serve stale cache. When enabled, edge nodes can respond to user requests with cached expired files when the origin server is unavailable. Valid values:

• on: enabled.

• off: disabled.

• Enables caching on specified ports.

• Valid values: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, and 2096.

• Multiple ports are separated by commas (,).

The cache deception armor. Protects against web cache deception attacks by caching only content that passes validation. Valid values:

• on: enabled.

• off: disabled.

Specifies whether to enable POST caching.

The cache key handling mode for POST caching. The following two modes are supported:

• md5: calculates the MD5 hash of the body content and adds the MD5 value to the cache key.

• ignore: ignores the body content in the cache key.

The body size limit for POST caching. The value is a number in KB. Valid values: 1 to 8. If this parameter is left empty, the default value of 8 KB takes effect.