cache_key_query

Property Manager name: Cache Key Query Parameters
Behavior version: The v2024-01-09 rule format supports the cache_key_query_params behavior v1.2.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters.

Note also that whenever you apply behavior that generates new cache keys, your origin server may experience traffic spikes before the new cache starts to serve out.

Option	Type	Description	Requires
`behavior`	enum	Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is not reflected in the cached object.		{"displayType":"enum","options":["INCLUDE_ALL_PRESERVE_ORDER","INCLUDE_ALL_ALPHABETIZE_ORDER","IGNORE_ALL","INCLUDE","IGNORE"],"tag":"select"}
	`INCLUDE_ALL_PRESERVE_ORDER`	Forms a separate key for the entire set of query parameters, but sensitive to the order in which they appear. (For example, `?q=akamai&state=ma` and `?state=ma&q=akamai` cache separately.)
	`INCLUDE_ALL_ALPHABETIZE_ORDER`	Forms keys for the entire set of parameters, but the order doesn't matter. The examples above both use the same cache key.
	`IGNORE_ALL`	Causes query string parameters to be ignored when forming cache keys.
	`INCLUDE`	Include the sequence of values in the `parameters` field.
	`IGNORE`	Include all but the sequence of values in the `parameters` field.
`parameters`	string array	Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes.	`behavior` is either: `INCLUDE`, `IGNORE`	{"displayType":"string array","tag":"input","todo":true} {"if":{"attribute":"behavior","op":"in","value":["INCLUDE","IGNORE"]}}
`exact_match`	boolean	When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes.	`behavior` is either: `INCLUDE`, `IGNORE`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"behavior","op":"in","value":["INCLUDE","IGNORE"]}}