通过 API 创建 URL rewrite 规则

使用 Rulesets API 通过 API 创建 URL Rewrite Rules。常见用例请参阅 Rules 示例库。

如果使用 Terraform，请参阅使用 Terraform 配置 Transform Rules。

基本规则设置

通过 API 创建 URL rewrite 规则时，请确保：

将规则操作设为 rewrite。
根据 URL rewrite 类型（静态或动态），在 action_parameters 字段中定义 URL rewrite 参数。
将规则部署到 zone 级别的 http_request_transform 阶段。

操作步骤

通过 API 为给定 zone 创建 a URL rewrite rule 时，请遵循以下工作流：

使用 List zone rulesets 操作检查 zone 级别是否已有 http_request_transform phase 的 ruleset。
如果 phase ruleset 不存在，使用 Create a zone ruleset 操作创建。在新 ruleset 属性中设置以下值：
- kind：zone
- phase：http_request_transform
使用 Update a zone ruleset 操作将 a URL rewrite rule 添加到 ruleset 规则列表。或者，在上一步的 Create a zone ruleset 请求中包含该规则。

请确保你的 API 令牌具有执行 API 操作所需的权限。

示例请求

示例：添加执行静态 URL rewrite 的规则

以下示例使用 Update a zone ruleset 操作，将现有阶段规则集（$RULESET_ID）的规则设为单条 URL rewrite 规则——对 URI 路径执行静态重写。响应将包含你更新后的规则集完整定义。

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 '{
		"rules": [
				{
						"ref": "rewrite_eu_to_emea",
						"expression": "(http.request.uri.query contains \"eu\")",
						"description": "My first static URL rewrite rule",
						"action": "rewrite",
						"action_parameters": {
								"uri": {
										"path": {
												"value": "/emea.html"
										}
								}
						}
				}
		]
	}'

{
	"result": {
		"ref": "rewrite_eu_to_emea",
		"id": "<RULESET_ID>",
		"name": "Zone-level Transform Ruleset",
		"description": "Zone-level ruleset that will execute Transform Rules.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "rewrite",
				"action_parameters": {
					"uri": {
						"path": {
							"value": "/emea.html"
						}
					}
				},
				"expression": "(http.request.uri.query contains \"eu\")",
				"description": "My first static URL rewrite rule",
				"last_updated": "2021-04-14T14:42:04.219025Z",
				"ref": "<RULE_REF>"
			}
		],
		"last_updated": "2021-04-14T14:42:04.219025Z",
		"phase": "http_request_transform"
	},
	"success": true,
	"errors": [],
	"messages": []
}

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

示例：添加执行动态 URL rewrite 的规则

以下示例使用 Update a zone ruleset 操作，将现有阶段规则集（$RULESET_ID）的规则设为单条 URL rewrite 规则——对 URI 路径执行动态重写。响应将包含你更新后的规则集完整定义。

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 '{
		"rules": [
				{
						"ref": "rewrite_2012_to_archive",
						"expression": "starts_with(http.request.uri.path, \"/news/2012/\")",
						"description": "My first dynamic URL rewrite rule",
						"action": "rewrite",
						"action_parameters": {
								"uri": {
										"path": {
												"expression": "concat(\"/archive\", http.request.uri.path)"
										}
								}
						}
				}
		]
	}'

{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level Transform Ruleset",
		"description": "Zone-level ruleset that will execute Transform Rules.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"ref": "rewrite_2012_to_archive",
				"id": "<RULE_ID>",
				"version": "1",
				"action": "rewrite",
				"action_parameters": {
					"uri": {
						"path": {
							"expression": "concat(\"/archive\", http.request.uri.path)"
						}
					}
				},
				"expression": "starts_with(http.request.uri.path, \"/news/2012/\")",
				"description": "My first dynamic URL rewrite rule",
				"last_updated": "2021-04-14T14:42:04.219025Z",
				"ref": "<RULE_REF>"
			}
		],
		"last_updated": "2021-04-14T14:42:04.219025Z",
		"phase": "http_request_transform"
	},
	"success": true,
	"errors": [],
	"messages": []
}

所需 API 令牌权限

用于管理 URL Rewrite Rules 的 API 请求中使用的 API 令牌至少需要具备以下权限：

Account > Transform Rules > Edit
Account > Account Rulesets > Read