通过 API 创建重定向规则

使用 Rulesets API 通过 API 创建重定向规则。

将重定向规则添加到区域 (zone) 级别的 http_request_dynamic_redirect 阶段的入口点规则集。有关创建规则集以及为规则集提供规则列表的更多信息，请参阅 Rulesets API 文档。

基本规则设置

一个重定向规则必须具有：

action（操作）设置为 redirect。
一个包含其他配置设置的 action_parameters 对象 — 有关详细信息，请参阅单条重定向设置。

示例请求

以下对创建区域规则集操作的请求会在区域级别为 http_request_dynamic_redirect 阶段创建阶段入口点规则集，并使用动态 URL 重定向定义单个重定向规则。如果您尚未为 http_request_dynamic_redirect 阶段创建阶段入口点规则集，请使用此操作。

Required API token permissions

At least one of the following token permissions is required:

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

Create a zone rulesetbash

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
								}
						}
				}
		]
	}'

响应 (Response)

{
	"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": []
}

使用 Terraform 时，通过 ref 字段可在更新后保持稳定的规则 ID。添加该字段可防止 Terraform 在变更时重建规则。更多信息请参阅故障排除（Terraform 文档）。

如果已经存在 http_request_dynamic_redirect 阶段的阶段入口点规则集，请改用更新区域规则集操作，如以下示例所示：

Required API token permissions

At least one of the following token permissions is required:

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

Update a zone rulesetbash

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
								}
						}
				}
		]
	}'

响应 (Response)

{
	"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 令牌必须至少具有以下权限：

Zone > Single Redirect > Edit