跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

自定义规则集(zone 级别)

最后更新 查看 MarkdownAgent 设置

自定义规则集是自定义规则的集合,您可以在 zone 或 账户级别 部署。

与 自定义规则 类似,自定义规则集允许您通过过滤请求来控制传入流量。

例如,您可以将自定义规则集应用于 zone 的全部传入请求,或仅应用于其中一部分传入请求。

在 zone 级别,所有客户都可以创建并部署自定义规则集。账户级自定义规则集需要 Enterprise 计划。有关计划限制,请参阅 可用性。

在仪表板中创建并部署自定义规则集

要在 zone 级别创建并部署自定义规则集:

  1. 在 Cloudflare 仪表板中,前往 Security rules(安全规则) 页面。

    前往 Security rules(安全规则) ↗
  2. 在 Custom rules(自定义规则) 中,选择 Create ruleset(创建规则集)。

  3. 输入名称,并可选择填写自定义规则集的描述。

  4. 在 Scope(范围) 下,定义自定义规则集应何时运行。

    • 选择 All incoming requests(全部传入请求),将规则集应用于该 zone 的所有传入请求。
    • 选择 Custom filter expression(自定义筛选表达式),定义应运行该规则集的请求。使用 Field(字段)、Operator(运算符) 和 Value(值) 构建表达式。也可以选择 Edit expression(编辑表达式),使用 表达式编辑器。
  5. 要向规则集添加规则,选择 Add rule(添加规则)。

  6. 在 Rule name(规则名称) 中输入描述性名称。

  7. 在 When incoming requests match(当传入请求匹配时) 下,定义规则适用的请求。使用 Field(字段)、Operator(运算符) 和 Value(值) 构建表达式。也可以选择 Edit expression(编辑表达式),使用 表达式编辑器。

  8. 在 Choose action(选择操作) 中,为匹配的请求选择操作。

  9. 选择 Deploy(部署)。

  10. (可选)向自定义规则集添加其他规则。

  11. 选择 Create(创建)。

在仪表板中编辑自定义规则集

  1. 在 Cloudflare 仪表板中,前往 Security rules(安全规则) 页面。

    前往 Security rules(安全规则) ↗
  2. 在 Custom rules(自定义规则) 中,选择要更新的自定义规则集旁的三个点 > Edit(编辑)。

  3. 更新规则集范围或其规则。

  4. 部署任何规则更改,然后选择 Back to rulesets list(返回规则集列表)。

在仪表板中删除自定义规则集

  1. 在 Cloudflare 仪表板中,前往 Security rules(安全规则) 页面。

    前往 Security rules(安全规则) ↗
  2. 在 Custom rules(自定义规则) 中,选择要删除的自定义规则集旁的三个点 > Delete(删除)。

  3. 要确认操作,选择 Delete(删除)。

通过 API 部署自定义规则集

创建自定义规则集并不会激活它。只有当带有 execute 操作的规则从 阶段入口点规则集(Cloudflare 在给定 阶段 为每个请求评估的顶级规则集)引用该自定义规则集时,它才会运行。

要为 zone 部署自定义规则集:

  1. 在 zone 级别创建包含一条或多条规则的自定义规则集。或者,使用 List zone rulesets API 操作识别要部署的现有自定义规则集。
  2. 向 http_request_firewall_custom 阶段入口点规则集添加一条带有 execute 操作的规则,并引用该自定义规则集 ID。此规则指示 Cloudflare 在规则表达式匹配时运行该自定义规则集。

1. 创建自定义规则集

以下请求在 zone 级别创建包含两条规则的新自定义规则集。响应将在 id 字段中包含新自定义规则集的 ID。

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF 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": "Custom Ruleset 1",
		"description": "My First Custom Ruleset (zone)",
		"kind": "custom",
		"phase": "http_request_firewall_custom",
		"rules": [
				{
						"expression": "(ip.src.country in {\"GB\" \"FR\"} and cf.bot_management.score < 20 and not cf.bot_management.verified_bot)",
						"action": "challenge",
						"description": "challenge GB and FR based on bot score"
				},
				{
						"expression": "not http.request.uri.path wildcard \"/api/*\"",
						"action": "challenge",
						"description": "challenge not /api"
				}
		]
	}'
{
	"result": {
		"id": "f82ccda3d21f4a02825d3fe45b5e1c10",
		"name": "Custom Ruleset 1",
		"description": "My First Custom Ruleset (zone)",
		"kind": "custom",
		"version": "1",
		"rules": [
			{
				"expression": "(ip.src.country in {\"GB\" \"FR\"} and cf.bot_management.score < 20 and not cf.bot_management.verified_bot)",
				"action": "challenge",
				"description": "challenge GB and FR based on bot score"
			},
			{
				"expression": "not http.request.uri.path wildcard \"/api/*\"",
				"action": "challenge",
				"description": "challenge not /api"
			}
		],
		"last_updated": "2025-11-09T10:27:30.636197Z",
		"phase": "http_request_firewall_custom"
	},
	"success": true,
	"errors": [],
	"messages": []
}

2. 部署自定义规则集

通过向 http_request_firewall_custom 阶段入口点规则集添加一条带有 "action": "execute" 的规则来部署自定义规则集。

  1. 调用获取区域入口点规则集操作,以获取 http_request_firewall_custom 阶段的入口点规则集定义。您需要有区域 ID才能完成此任务。

    Required API token permissions

    At least one of the following token permissions is required:
    • Zone WAF Write
    • Zone WAF Read
    Get a zone entry point rulesetbash
    curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_custom/entrypoint" \
    	--request GET \
    	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
    {
    	"result": {
    		"description": "Zone-level phase entry point",
    		"id": "<ENTRY_POINT_RULESET_ID>",
    		"kind": "zone",
    		"last_updated": "2025-11-16T15:40:08.202335Z",
    		"name": "zone",
    		"phase": "http_request_firewall_custom",
    		"rules": [
    			// ...
    		],
    		"version": "10"
    	},
    	"success": true,
    	"errors": [],
    	"messages": []
    }
  2. 如果入口点规则集已存在(即,如果您收到 200 OK 状态代码和规则集定义),请记下响应中的规则集 ID。然后,调用创建区域规则集规则操作,向现有规则集中添加一条 execute 规则,以部署 custom ruleset you created in Step 1 (replace f82ccda3d21f4a02825d3fe45b5e1c10 with your custom ruleset ID).
    Since the expression is true, the custom ruleset will run for all incoming requests。默认情况下,该规则将添加到规则集中已有规则列表的末尾。

    Required API token permissions

    At least one of the following token permissions is required:
    • Zone WAF Write
    Create a zone ruleset rulebash
    curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$ENTRY_POINT_RULESET_ID/rules" \
    	--request POST \
    	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    	--json '{
    		"action": "execute",
    		"expression": "true",
    		"action_parameters": {
    				"id": "f82ccda3d21f4a02825d3fe45b5e1c10"
    		},
    		"description": "Execute custom ruleset"
    	}'
    {
    	"result": {
    		"id": "<ENTRY_POINT_RULESET_ID>",
    		"name": "zone",
    		"description": "Zone-level phase entry point",
    		"kind": "zone",
    		"version": "11",
    		"rules": [
    			// ... any existing rules
    			{
    				"id": "<RULE_ID>",
    				"version": "1",
    				"action": "execute",
    				"action_parameters": {
    					"id": "f82ccda3d21f4a02825d3fe45b5e1c10"
    				},
    				"expression": "true",
    				"description": "Execute custom ruleset",
    				"last_updated": "2025-11-18T18:08:14.003361Z",
    				"ref": "<RULE_REF>",
    				"enabled": true
    			}
    		],
    		"last_updated": "2025-11-18T18:08:14.003361Z",
    		"phase": "http_request_firewall_custom"
    	},
    	"success": true,
    	"errors": [],
    	"messages": []
    }
  3. 如果入口点规则集不存在(即在步骤 1 中收到 404 Not Found 状态码),请使用创建 zone 规则集操作创建它。在 rules 数组中包含一个规则,为 all incoming requests in the zone 执行 custom ruleset。Replace f82ccda3d21f4a02825d3fe45b5e1c10 with your custom ruleset ID.

    Required API token permissions

    At least one of the following token permissions is required:
    • Zone WAF 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": "zone",
    		"description": "Zone-level phase entry point",
    		"kind": "zone",
    		"phase": "http_request_firewall_custom",
    		"rules": [
    				{
    						"action": "execute",
    						"action_parameters": {
    								"id": "f82ccda3d21f4a02825d3fe45b5e1c10"
    						},
    						"expression": "true",
    						"description": "Execute custom ruleset"
    				}
    		]
    	}'

后续步骤

使用 Rulesets API 中的不同操作来处理您创建并部署的自定义规则集。下表列出了在 zone 级别使用自定义规则集的常见任务:

任务 步骤
获取自定义规则集列表

使用 List zone rulesets 操作,并搜索 "kind": "custom" 且 "phase": "http_request_firewall_custom" 的规则集。响应将包含规则集 ID。

更多信息请参阅 List existing rulesets。

列出自定义规则集中的所有规则

使用带有自定义规则集 ID 的 Get a zone ruleset 操作,以获取已配置规则及其 ID 的列表。

更多信息请参阅 View a specific ruleset。

更新自定义规则

使用 Update a zone ruleset rule 操作。您需要提供自定义规则集 ID 和规则 ID。

更多信息请参阅 Update a rule in a ruleset。

删除自定义规则

使用 Delete a zone ruleset rule 操作。您需要提供自定义规则集 ID 和规则 ID。

更多信息请参阅 Delete a rule in a ruleset。

更多资源

有关通过 Cloudflare API 使用自定义规则集的更多信息,请参阅 Ruleset Engine 文档中的 Work with custom rulesets。

这篇文档对您有帮助吗?