JSON 对象

本页介绍通过 Rulesets API 创建或更新规则集及其规则的 API 请求中所使用的 JSON 对象，以及 API 返回的对象。

完整填充的规则集对象具有以下 JSON 结构。

{
	"id": "6a359df138c442b385d20140d4d96919",
	"name": "Example Ruleset",
	"description": "Description of Example Ruleset",
	"kind": "custom",
	"version": "2",
	"phase": "http_request_firewall_custom",
	"rules": [
		{
			"id": "fdb0dd271f3f40b19679cc5d91396024",
			"version": "2",
			"action": "block",
			"expression": "cf.zone.name eq \"example.com\" ",
			"last_updated": "2022-07-20T10:44:29.124515Z"
		}
	],
	"last_updated": "2022-07-20T10:44:29.124515Z"
}

有关 rules 数组中规则项的属性详情，请参阅 规则对象结构与属性 部分。

规则集对象具有以下属性：

• id String

  • 一个 32 字符的 UUIDv4 字符串，表示给定版本规则集的 Cloudflare 生成的唯一标识符。
  • 唯一，只读。

• name String

  • 规则集的人类可读名称。
  • 名称不可变。在规则集的整个生命周期内无法更改名称。

• description String

  • 规则集的可选描述。
  • 您可以在规则集的整个生命周期内更改描述。

• kind String

  • 该 JSON 对象所表示的规则集类型。
  • 取值为 root、zone、managed、custom 之一。
  • kind 不可变。

• version Integer

  • 规则集的版本。
  • 只读值，从 1 开始，每次修改规则集时递增 1。

• rules Array<Rule>

  • 要包含在规则集中的规则列表。请参阅 规则对象结构与属性 了解详情。

• last_updated Timestamp

  • 规则集上次更新的时间（UTC），采用 ISO 8601 格式：YYYY-MM-DDThh:mm:ss.TZD。
  • 只读。

完整填充的规则 JSON 对象具有以下结构：

{
	"id": "fdb0dd271f3f40b19679cc5d91396024",
	"version": "2",
	"ref": "<REF>",
	"description": "<DESCRIPTION>",
	"action": "block",
	"action_parameters": [
		// action parameters vary according to the action
	],
	"categories": ["<CATEGORY_1>", "<CATEGORY_2>"],
	"expression": "cf.zone.name eq \"example.com\"",
	"last_updated": "2025-07-20T10:44:29.124515Z",
	"enabled": true
}

规则的 JSON 对象属性定义如下：

• id String

  • 一个 32 字符的 UUIDv4 字符串，表示给定版本规则的 Cloudflare 生成的唯一标识符。
  • 唯一，只读。

• version Integer

  • 规则的版本。
  • 只读值，从 1 开始，每次修改规则时递增 1。
  • 更改规则在规则集中的顺序不会更改其版本。

• ref String

  • 用户定义的外部标识符，在规则集中的每条规则之间必须唯一。
  • 在 Terraform 配置中使用此字段，可防止 Terraform 在变更时重新创建规则。请参阅 如何在修改之间保持相同的规则 ID 了解更多信息。

• description String

  • 规则的描述性名称。

• action String

  • 定义规则表达式匹配时执行的操作。
  • 可用的 操作 取决于执行该规则所属规则集的 phase。

• action_parameters Object

  • 配置规则操作的一个或多个参数。
  • 确切属性因操作而异。请参阅各 Cloudflare 产品的 API 说明了解更多信息。

• categories Array<String>

  • 与当前规则关联的标签。您可以定义影响具有给定标签的规则的覆盖。
  • 只读。仅在 WAF Managed Rules 和 DDoS managed rulesets 中可用。

• expression String

  • 定义当前规则何时匹配的条件。
  • 可在规则表达式中使用的字段和函数取决于执行该规则所属规则集的 phase。

• last_updated Timestamp

  • 规则上次更新的时间（UTC），采用 ISO 8601 格式：YYYY-MM-DDThh:mm:ss.TZD。
  • 只读。

• enabled Boolean

  • 设置为 true 时，当前规则已启用。