跳转到内容
搜索文档
↵选择
↑↓导航
ESC关闭

查看规则集

最后更新 查看 MarkdownAgent 设置

本页包含以下 API 操作的示例：

查看可用规则集

您可以列出 zone 或账户的可用规则集。

有关 API 端点列表，请参阅 列出并查看规则集。

示例：在 zone 级别查看可用规则集

获取 zone 级别规则集列表的 GET 请求 响应将包含以下规则集：

  • 您可以部署的托管规则集，由 "kind": "managed" 表示。
  • zone 级别阶段入口点规则集（如已配置），由 "kind": "zone" 表示。
  • 自定义规则集（如已配置），由 "kind": "custom" 表示。

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Response Compression Read
  • Config Settings Write
  • Config Settings Read
  • Dynamic URL Redirects Write
  • Dynamic URL Redirects Read
  • Cache Settings Write
  • Cache Settings Read
  • Custom Errors Write
  • Custom Errors Read
  • Origin Write
  • Origin Read
  • Managed headers Write
  • Managed headers Read
  • Zone Transform Rules Write
  • Zone Transform Rules Read
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • HTTP DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Read
  • Sanitize Write
  • Sanitize Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Bot Management Write
  • Bot Management Read
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
  • Logs Write
  • Logs Read
List zone rulesetsbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": [
		{
			"id": "<ZONE_PHASE_RULESET_ID>",
			"name": "Zone-level Ruleset 1",
			"description": "Ruleset for http_request_firewall_managed phase at the zone level",
			"kind": "zone",
			"version": "2",
			"last_updated": "2021-03-12T14:11:59.754817Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_MANAGED_RULESET_ID>",
			"name": "Cloudflare Managed Ruleset",
			"description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives",
			"kind": "managed",
			"version": "2",
			"last_updated": "2021-03-18T14:42:40.972022Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_OWASP_CORE_RULESET_ID>",
			"name": "Cloudflare OWASP Core Ruleset",
			"description": "Cloudflare's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository",
			"kind": "managed",
			"version": "3",
			"last_updated": "2021-03-18T14:42:42.993211Z",
			"phase": "http_request_firewall_managed"
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

示例：在账户级别查看可用规则集

获取账户级别规则集列表的 GET 请求 响应将包含以下规则集：

  • 您可以部署的托管规则集，由 "kind": "managed" 表示。
  • 账户级别阶段入口点规则集（如已配置），由 "kind": "root" 表示。
  • 自定义规则集（如已配置），由 "kind": "custom" 表示。

Required API token permissions

At least one of the following token permissions is required:
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
List account rulesetsbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": [
		{
			"id": "<CUSTOM_RULESET_ID>",
			"name": "Custom Ruleset 1",
			"description": "My custom ruleset",
			"kind": "custom",
			"version": "10",
			"last_updated": "2020-11-23T11:36:24.192361Z",
			"phase": "http_request_firewall_custom"
		},
		{
			"id": "<ACCOUNT_PHASE_RULESET_ID>",
			"name": "Account-level ruleset for http_request_firewall_managed phase",
			"description": "Account-level ruleset for executing one or more Managed Rulesets",
			"kind": "root",
			"version": "2",
			"last_updated": "2021-03-12T14:06:41.323932Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_MANAGED_RULESET_ID>",
			"name": "Cloudflare Managed Ruleset",
			"description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives",
			"kind": "managed",
			"version": "5",
			"last_updated": "2021-03-18T14:42:40.972022Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_OWASP_CORE_RULESET_ID>",
			"name": "Cloudflare OWASP Core Ruleset",
			"description": "Cloudflare's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository",
			"kind": "managed",
			"version": "3",
			"last_updated": "2021-03-18T14:42:42.993211Z",
			"phase": "http_request_firewall_managed"
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

获取入口点规则集

您可以获取 zone 或账户级别给定 阶段 的 入口点规则集 定义。

如果入口点规则集存在，API 将返回 200 OK HTTP 状态码，以及规则集定义。

如果入口点规则集不存在，API 将返回 404 Not Found HTTP 状态码。

示例：在 zone 级别获取入口点规则集

以下 GET 请求 获取 zone 级别 http_request_firewall_managed 阶段的入口点规则集定义。在此示例中，入口点规则集存在且包含一条规则。

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Response Compression Read
  • Config Settings Write
  • Config Settings Read
  • Dynamic URL Redirects Write
  • Dynamic URL Redirects Read
  • Cache Settings Write
  • Cache Settings Read
  • Custom Errors Write
  • Custom Errors Read
  • Origin Write
  • Origin Read
  • Managed headers Write
  • Managed headers Read
  • Zone Transform Rules Write
  • Zone Transform Rules Read
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • HTTP DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Read
  • Sanitize Write
  • Sanitize Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Bot Management Write
  • Bot Management Read
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
  • Logs Write
  • Logs Read
Get a zone entry point rulesetbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point ruleset",
		"description": "This ruleset executes a managed ruleset.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"expression": "true",
				"action_parameters": {
					"id": "<MANAGED_RULESET_ID>"
				},
				"last_updated": "2021-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2021-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

示例：在账户级别获取入口点规则集

以下 GET 请求 获取账户级别 http_request_firewall_managed 阶段的入口点规则集定义。

Required API token permissions

At least one of the following token permissions is required:
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
Get an account entry point rulesetbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

查看规则集中包含的规则

您可以查看阶段入口点规则集（账户和 zone 级别）以及自定义规则集的所有版本，但只能查看托管规则集的最新版本。

示例：查看 zone 级别阶段入口点规则集中的规则

以下 GET 请求 列出 zone 级别 http_request_firewall_managed 阶段入口点规则集版本 2 中的规则。

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Response Compression Read
  • Config Settings Write
  • Config Settings Read
  • Dynamic URL Redirects Write
  • Dynamic URL Redirects Read
  • Cache Settings Write
  • Cache Settings Read
  • Custom Errors Write
  • Custom Errors Read
  • Origin Write
  • Origin Read
  • Managed headers Write
  • Managed headers Read
  • Zone Transform Rules Write
  • Zone Transform Rules Read
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • HTTP DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Read
  • Sanitize Write
  • Sanitize Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Bot Management Write
  • Bot Management Read
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
  • Logs Write
  • Logs Read
Get a zone entry point ruleset versionbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint/versions/2" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point ruleset",
		"description": "This ruleset executes a managed ruleset.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"expression": "true",
				"action_parameters": {
					"id": "<MANAGED_RULESET_ID>"
				},
				"last_updated": "2021-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2021-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

示例：查看托管规则集中的规则

以下 GET 请求 列出托管规则集版本 2（该规则集的最新版本）中的规则。

托管规则集中的每条规则可以有关联的标签或类别，列在 categories 字段中。

Required API token permissions

At least one of the following token permissions is required:
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
Get an account ruleset versionbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets/$MANAGED_RULESET_ID/versions/2" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": {
		"id": "<MANAGED_RULESET_ID>",
		"name": "Cloudflare Managed Ruleset",
		"description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives",
		"kind": "managed",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_1_ID>",
				"version": "1",
				"action": "log",
				"categories": [
					"cve-2014-5265",
					"cve-2014-5266",
					"cve-2014-5267",
					"dos",
					"drupal",
					"wordpress"
				],
				"description": "Drupal, Wordpress - DoS - XMLRPC - CVE:CVE-2014-5265, CVE:CVE-2014-5266, CVE:CVE-2014-5267",
				"last_updated": "2021-03-18T14:42:40.972022Z",
				"ref": "<RULE_1_REF>",
				"enabled": true
			},
			{
				"id": "<RULE_2_ID>",
				"version": "1",
				"action": "block",
				"categories": ["broken-access-control", "cve-2018-12895", "wordpress"],
				"description": "Wordpress - Broken Access Control - CVE:CVE-2018-12895",
				"last_updated": "2021-03-18T14:42:40.972022Z",
				"ref": "<RULE_2_REF>",
				"enabled": true
			}
			// (...)
		],
		"last_updated": "2021-03-18T14:42:40.972022Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

相关资源

有关查看规则集的可用 API 方法的更多信息，请参阅 列出并查看规则集。

这篇文档对您有帮助吗？