תיעוד 32
יצירת כלל באמצעות API
עודכן לאחרונה ב-16 באפריל 2026.
השתמשו ב-Rulesets API כדי ליצור כלל Cache Response Rule באמצעות API. כדי להגדיר את ה-API של Cloudflare, ראו את תיעוד ה-API.
#הגדרות בסיסיות של כלל
כשיוצרים כלל Cache Response Rule באמצעות API, ודאו שאתם:
- מגדירים את פעולת הכלל לאחת מהפעולות הזמינות.
- מגדירים את הפרמטרים בשדה
action_parametersבהתאם להגדרות שברצונכם להגדיר לתגובות התואמות. - פורסים את הכלל ל-ruleset של נקודת הכניסה של השלב
http_response_cache_settings.
#תהליך
- השתמשו בשיטה List zone rulesets כדי לבדוק אם כבר קיים ruleset לשלב
http_response_cache_settings. - אם ה-ruleset של השלב לא קיים, צרו אותו באמצעות הפעולה Create a zone ruleset. במאפייני ה-ruleset החדש, הגדירו את הערכים הבאים:
kind:zonephase:http_response_cache_settings
- השתמשו בפעולה Update a zone ruleset כדי להוסיף כללים ל-ruleset. לחלופין, כללו את הכללים בבקשה Create a zone ruleset שצוינה בשלב הקודם.
#בקשות לדוגמה
הדוגמאות האלה מדגימות את כל הפעולות הזמינות ב-Cache Response Rules באמצעות קריטריונים להתאמת בקשה ותגובה. שימוש ישיר בדוגמאות האלה יגרום להחלפת כל הכללים הקיימים בשלב.
דוגמה: הסרת כותרות תגובה מקבצי JS לפני שמירה במטמון
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
}
}
]
}'דוגמה: הגדרת תגי מטמון סטטיים בתגובות API
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"
]
}
}
]
}'דוגמה: הוספת תגי מטמון מכותרת תגובה באמצעות ביטוי
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)"
}
}
]
}'דוגמה: דריסת cache-control באמצעות max-age
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
}
}
}
]
}'דוגמה: הגדרת הנחיית private עם qualifiers
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"
}
}
}
]
}'דוגמה: הגדרת immutable לקבצי גופן סטטיים
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
}
}
}
]
}'דוגמה: מספר כללים עם הסרת כותרות, תיוג תגובות והגדרת cache control
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"
}
}
}
]
}'#הרשאות נדרשות לטוקן API
טוקן ה-API שמשמש בבקשות API לניהול Cache Response Rules חייב לכלול את ההרשאות הבאות:
Zone>Cache Rules>EditAccount Rulesets>EditAccount Filter Lists>Edit