← Правила Cloudflare / rules / url-forwarding / single-redirects

Создайте redirect rule через API

Используйте Rulesets API для создания правила редиректа через API.

Добавьте правила редиректов в точку входа набора правил http_request_dynamic_redirect фаза на уровне зоны. См. Rulesets API документацию, чтобы узнать больше о создание ruleset и указав список правил для набора правил.

Базовые настройки правила

Redirect rule должно содержать:

action имеет значение redirect
Одна action_parameters объект с дополнительными настройками конфигурации, см. Настройки Single Redirects для получения подробностей.

Примеры запросов

Следующий запрос Создание набора правил зоны создаёт входной набор правил фазы для http_request_dynamic_redirect фаза на уровне зоны, определяющая одно правило перенаправления с динамическим перенаправлением URL. Используйте эту операцию, если вы ещё не создали набор правил точки входа для фазы http_request_dynamic_redirect фазу ещё не создали.

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:

Response Compression Write
Config Settings Write
Dynamic URL Redirects Write
Cache Settings Write
Custom Errors Write
Origin Write
Managed headers Write
Zone Transform Rules Write
Mass URL Redirects Write
Magic Firewall Write
L4 DDoS Managed Ruleset Write
HTTP DDoS Managed Ruleset Write
Sanitize Write
Transform Rules Write
Select Configuration Write
Bot Management Write
Zone WAF Write
Account WAF Write
Account Rulesets Write
Logs Write
Logs Write

Создание набора правил зоны

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "Redirect rules ruleset",
		"kind": "zone",
		"phase": "http_request_dynamic_redirect",
		"rules": [
				{
						"ref": "redirect_gb_fr_to_localized",
						"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
						"description": "Redirect GB and FR users in home page to localized site.",
						"action": "redirect",
						"action_parameters": {
								"from_value": {
										"target_url": {
												"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
										},
										"status_code": 307,
										"preserve_query_string": true
								}
						}
				}
		]
	}'

Ответ

{
	"result": {
		"id": "528f4f03bf0da53a29907199625867be",
		"name": "Redirect rules ruleset",
		"kind": "zone",
		"version": "1",
		"rules": [
			{
				"ref": "redirect_gb_fr_to_localized",
				"id": "235e557b92fd4e5e8753ee665a9ddd75",
				"version": "1",
				"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
				"description": "Redirect GB and FR users in home page to localized site.",
				"action": "redirect",
				"action_parameters": {
					"from_value": {
						"target_url": {
							"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
						},
						"status_code": 307,
						"preserve_query_string": true
					}
				},
				"last_updated": "2022-09-28T09:20:42Z"
			}
		],
		"last_updated": "2022-09-28T09:20:42Z",
		"phase": "http_request_dynamic_redirect"
	},
	"success": true,
	"errors": [],
	"messages": []
}

Используйте ref поле, чтобы идентификаторы правил оставались стабильными при обновлениях в Terraform. Добавление этого поля не позволяет Terraform пересоздавать правило при изменениях. Дополнительную информацию см. в Устранение неполадок в документации Terraform.

Если для фазы уже есть entry point ruleset для http_request_dynamic_redirect фазы используйте Обновление набора правил зоны операцию, как показано в следующем примере:

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:

Response Compression Write
Config Settings Write
Dynamic URL Redirects Write
Cache Settings Write
Custom Errors Write
Origin Write
Managed headers Write
Zone Transform Rules Write
Mass URL Redirects Write
Magic Firewall Write
L4 DDoS Managed Ruleset Write
HTTP DDoS Managed Ruleset Write
Sanitize Write
Transform Rules Write
Select Configuration Write
Bot Management Write
Zone WAF Write
Account WAF Write
Account Rulesets Write
Logs Write
Logs Write

Обновление набора правил зоны

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "Redirect rules ruleset",
		"kind": "zone",
		"phase": "http_request_dynamic_redirect",
		"rules": [
				{
						"ref": "redirect_gb_fr_to_localized",
						"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
						"description": "Redirect GB and FR users in home page to localized site.",
						"action": "redirect",
						"action_parameters": {
								"from_value": {
										"target_url": {
												"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
										},
										"status_code": 307,
										"preserve_query_string": true
								}
						}
				},
				{
						"ref": "redirect_contacts_to_new_page",
						"expression": "http.request.uri.path eq \"/contacts.html\"",
						"description": "Redirect to new contacts page.",
						"action": "redirect",
						"action_parameters": {
								"from_value": {
										"target_url": {
												"value": "https://example.com/contact-us/"
										},
										"status_code": 308
								}
						}
				}
		]
	}'

Ответ

{
	"result": {
		"id": "528f4f03bf0da53a29907199625867be",
		"name": "Redirect rules ruleset",
		"description": "",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"ref": "redirect_gb_fr_to_localized",
				"id": "235e557b92fd4e5e8753ee665a9ddd75",
				"version": "1",
				"action": "redirect",
				"action_parameters": {
					"from_value": {
						"target_url": {
							"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
						},
						"status_code": 307,
						"preserve_query_string": true
					}
				},
				"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
				"description": "Redirect GB and FR users in home page to localized site.",
				"last_updated": "2022-10-03T15:38:51.658387Z",
				"ref": "235e557b92fd4e5e8753ee665a9ddd75",
				"enabled": true
			},
			{
				"ref": "redirect_contacts_to_new_page",
				"id": "cfad5efbfcd1440fb5b30cf30f95ece3",
				"version": "1",
				"action": "redirect",
				"action_parameters": {
					"from_value": {
						"target_url": {
							"value": "https://example.com/contact-us/"
						},
						"status_code": 308
					}
				},
				"expression": "http.request.uri.path eq \"/contacts.html\"",
				"description": "Redirect to new contacts page.",
				"last_updated": "2022-10-03T15:38:51.658387Z",
				"ref": "cfad5efbfcd1440fb5b30cf30f95ece3",
				"enabled": true
			}
		],
		"last_updated": "2022-10-03T15:38:51.658387Z",
		"phase": "http_request_dynamic_redirect"
	},
	"success": true,
	"errors": [],
	"messages": []
}

Необходимые разрешения API-токена

Токен API, используемый в запросах API для управления redirect rules, должен иметь как минимум следующее разрешение:

Zone > Single Redirect > Изменить