Edge Security Acceleration:GetCacheRule

The request ID.

The configuration ID.

Whether the response contains a global or rule configuration. Valid values:

• global: A global configuration.

• rule: A rule configuration.

The version number of the site configuration. For sites with version management enabled, this value indicates the configuration version. Defaults to 0.

The rule execution order. Smaller values indicate higher priority.

Whether the rule is enabled. Applies only to rule configurations. Valid values:

• on: Enabled.

• off: Disabled.

The rule content, a conditional expression used to match user requests. Applies only to rule configurations.

• To match all incoming requests, use true.

• To match specific requests, use a custom expression, such as (http.host eq "video.example.com").

The rule name. Applies only to rule configurations.

Whether to cache requests or bypass the cache. Valid values:

• cache_all: Cache all requests.

• bypass_all: Bypass the cache for all requests.

The browser cache mode. Valid values:

• no_cache: Do not cache content.

• follow_origin: Follow the origin cache policy.

• override_origin: Override the origin cache policy.

The browser cache TTL, in seconds.

The edge cache mode. Valid values:

• follow_origin: Use the origin server's cache policy. If none is provided, the default policy applies.

• no_cache: Do not cache content.

• override_origin: Override the origin cache policy.

• follow_origin_bypass: Use the origin server's cache policy. If none is provided, content is not cached.

• follow_origin_override: Use the origin server's cache policy. If none is provided, a custom cache TTL applies.

The edge cache TTL, in seconds.

The status code cache TTL, in seconds.

• Set the cache TTL for a specific status code. For example, 404=10 specifies that responses with a 404 status code are cached for 10 seconds.

• Set the cache TTL for status code classes, such as 4xx and 5xx. For example, 4xx=10 specifies that all responses with a 4xx status code are cached for 10 seconds.

• Separate multiple entries with commas.

Whether to sort query strings before generating the cache key. Valid values:

• on: Enabled.

• off: Disabled.

The query string handling mode for cache key generation. Valid values:

• ignore_all: Ignore all query strings.

• exclude_query_string: Exclude specified query strings.

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

• include_query_string: Include specified query strings.

The query strings to include in or exclude from the cache key. Separate multiple query strings with spaces.

The headers to include in the cache key. Both header names (case-insensitive) and their values are added to the key. Separate multiple header names with spaces. Header names can contain the following characters:

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

• Digits: 0-9

• Letters: lowercase English letters a-z

The cookies to include in the cache key. Both cookie names (case-insensitive) and their values are added to the key. Separate multiple cookie names with spaces. Cookie names can contain the following characters:

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

• Digits: 0-9

• Letters: lowercase English letters a-z

The cache reserve eligibility. Controls whether a request bypasses the cache reserve node during an origin fetch. Valid values:

• bypass_cache_reserve: Bypass the cache reserve.

• eligible_for_cache_reserve: Eligible for cache reserve.

The headers whose presence is checked when generating a cache key. If a specified header exists in the request, its name (case-insensitive) is added to the cache key. Separate multiple header names with spaces. Header names can contain the following characters:

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

• Digits: 0-9

• Letters: lowercase English letters a-z

The cookies whose presence is checked when generating a cache key. If a specified cookie exists in the request, its name (case-insensitive) is added to the cache key. Separate multiple cookie names with spaces. Cookie names can contain the following characters:

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

• Digits: 0-9

• Letters: lowercase English letters a-z

Whether to include the client's device type in the cache key. Valid values:

• on: Enabled.

• off: Disabled.

Whether to include the client's geographic location in the cache key. Valid values:

• on: Enabled.

• off: Disabled.

Whether to include the client's language in the cache key. Valid values:

• on: Enabled.

• off: Disabled.

Whether to serve stale content. When enabled, edge nodes serve stale (expired) cached content when the origin server is unavailable. Valid values:

• on: Enabled.

• off: Disabled.

• Additional ports on which caching is enabled.

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

• Separate multiple ports with commas.

Whether to enable Cache Deception Armor, which helps mitigate web cache deception attacks by ensuring that only validated content is cached. Valid values:

• on: Enabled.

• off: Disabled.

Whether to enable POST request caching.

The body content handling mode for POST request cache key generation. Valid values:

• md5: Calculate the MD5 hash of the body content and add the hash to the cache key.

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

The size limit (in KB) of the body content for POST caching. The value is an integer from 1 to 8. A null or empty value defaults to 8 KB.