INTEGRITY Dokumentace

← Cloudflare Cache / cache / how-to / cache-response-rules

Vytvoření pravidla přes API

Použijte Rulesets API vytvořit Cache Response Rule přes API. Postup konfigurace Cloudflare API najdete v Dokumentace API.

Základní nastavení pravidla

Při vytváření Cache Response Rule přes API se ujistěte, že:

Nastavte akci pravidla na jednu z dostupné akce.
Definujte parametry v action_parameters pole podle nastavení které chcete nakonfigurovat pro odpovídající odpovědi.
Nasaďte pravidlo do http_response_cache_settings je vstupní sada pravidel dané fáze.

Postup

Použijte Seznam sad pravidel zóny metodu ke zjištění, zda již existuje ruleset pro http_response_cache_settings fáze.
Pokud fázový ruleset neexistuje, vytvořte jej pomocí Vytvoření rulesetu zóny operaci. Ve vlastnostech nového rulesetu nastavte následující hodnoty:
- kind: zone
- fáze: http_response_cache_settings
Použijte Aktualizace sady pravidel zóny operaci k přidání pravidel do rulesetu. Případně pravidla zahrňte do Vytvoření rulesetu zóny požadavek uvedený v předchozím kroku.

Příklady požadavků

Tyto příklady demonstrují všechny dostupné akce v Cache Response Rules s využitím kritérií pro porovnávání požadavků a odpovědí. Jejich přímé použití nahradí všechna stávající pravidla v dané fázi.

Příklad: Odstranění hlaviček odpovědi ze souborů JS před cachováním

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "http.request.uri.path.extension eq \"js\"",
						"description": "Strip caching headers from JS files",
						"action": "set_cache_settings",
						"action_parameters": {
								"strip_etags": true,
								"strip_set_cookie": true,
								"strip_last_modified": true
						}
				}
		]
	}'

Příklad: Nastavení statických cache tags na odpovědích API

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "http.request.uri.path starts_with \"/api/\"",
						"description": "Tag API responses for targeted purging",
						"action": "set_cache_tags",
						"action_parameters": {
								"operation": "set",
								"values": [
										"api-response",
										"dynamic-content"
								]
						}
				}
		]
	}'

Příklad: Přidání cache tags z hlavičky odpovědi pomocí výrazu

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "any(http.response.headers.names[*] == \"Surrogate-Keys\")",
						"description": "Extract cache tags from alternative CDN response header",
						"action": "set_cache_tags",
						"action_parameters": {
								"operation": "add",
								"expression": "split(http.response.headers[\"Surrogate-Keys\"][0], \",\", 1)"
						}
				}
		]
	}'

Příklad: Přepsání cache-control pomocí max-age

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "http.response.code eq 200",
						"description": "Override cache-control for successful responses",
						"action": "set_cache_control",
						"action_parameters": {
								"max-age": {
										"operation": "set",
										"value": 3600,
										"cloudflare_only": true
								}
						}
				}
		]
	}'

Příklad: Nastavení direktivy private s kvalifikátory

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "http.request.uri.path starts_with \"/user/\"",
						"description": "Mark user content as private",
						"action": "set_cache_control",
						"action_parameters": {
								"private": {
										"operation": "set",
										"qualifiers": [
												"X-User-Id",
												"X-Session-Token"
										]
								},
								"no-cache": {
										"operation": "set"
								}
						}
				}
		]
	}'

Příklad: Nastavení immutable pro statické fonty

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "http.request.uri.path.extension in {\"woff2\" \"woff\" \"ttf\"}",
						"description": "Mark fonts as immutable",
						"action": "set_cache_control",
						"action_parameters": {
								"immutable": {
										"operation": "set"
								},
								"max-age": {
										"operation": "set",
										"value": 31536000
								}
						}
				}
		]
	}'

Příklad: Více pravidel s odstraněním hlaviček, označením odpovědí tagy a nastavením cache control

Aktualizace vstupní sady pravidel zóny

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_response_cache_settings/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"expression": "http.response.code eq 200 and http.request.uri.path.extension eq \"html\"",
						"description": "Strip tracking headers from HTML responses",
						"action": "set_cache_settings",
						"action_parameters": {
								"strip_etags": true,
								"strip_set_cookie": true
						}
				},
				{
						"expression": "http.request.uri.path starts_with \"/products/\"",
						"description": "Tag product pages for purging",
						"action": "set_cache_tags",
						"action_parameters": {
								"operation": "add",
								"values": [
										"product-catalog",
										"storefront"
								]
						}
				},
				{
						"expression": "http.response.code eq 200",
						"description": "Set cache control for all 200 responses",
						"action": "set_cache_control",
						"action_parameters": {
								"s-maxage": {
										"operation": "set",
										"value": 86400,
										"cloudflare_only": true
								},
								"must-revalidate": {
										"operation": "set"
								}
						}
				}
		]
	}'

Požadovaná oprávnění API tokenu

API token použitý v API požadavcích pro správu Cache Response Rules musí mít následující oprávnění:

Zóna > Cache Rules > Úprava
Account Rulesets > Úprava
Account Filter Lists > Úprava