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

通过 API 配置顺序缓解

最后更新 查看 MarkdownAgent 设置

如需通过 API 配置序列缓解,请选择序列、规则类型和操作。以下示例展示 API 返回的一条规则。在响应中,position 是从一开始计数的整数:

Example response rule objectjson
{
	"id": "d4909253-390f-4956-89fd-92a5b0cd86d8",
	"title": "<RULE_TITLE>",
	"kind": "allow",
	"action": "block",
	"sequence": [
		"0d9bf70c-92e1-4bb3-9411-34a3bcc59003",
		"b704ab4d-5be0-46e0-9875-b2b3d1ab42f9"
	],
	"position": 1,
	"last_updated": "2023-07-24T12:06:51.796286Z",
	"created_at": "2023-07-24T12:06:51.796286Z"
}

此规则强制要求对端点 0d9bf70c-92e1-4bb3-9411-34a3bcc59003 的请求必须在对端点 b704ab4d-5be0-46e0-9875-b2b3d1ab42f9 的请求之前发生。

否则,对端点 b704ab4d-5be0-46e0-9875-b2b3d1ab42f9 的请求将被阻止。

字段

字段名称
描述 可选值 示例
id 标识规则的不透明标识符。 一个 UUID "d4909253-390f-4956-89fd-92a5b0cd86d8"
title 有助于识别规则的字符串。 1 到 50 个字符之间的值 "Allow checkout sequence"
kind 定义此规则的语义。Block 规则具有否定安全模型,允许显式拒绝某一顺序。Allow 规则具有肯定安全模型,拒绝除配置顺序之外的一切请求。 block, allow "block"
action 当规则匹配时,我们应该执行什么防火墙操作。 block,log "log"
sequence 表示组成此规则序列的操作(来自端点管理)。目前仅支持长度为二的序列。两个操作必须使用相同的主机名。第一个操作是起始端点,第二个操作是结束端点。 包含两个来自端点管理的有效操作 ID 的数组 ["0d9bf70c-92e1-4bb3-9411-34a3bcc59003", "b704ab4d-5be0-46e0-9875-b2b3d1ab42f9"]
position 表示此规则在所有序列规则中从一开始计数的位置。规则自上而下评估,因此位置值较小的规则会先评估。响应返回一个整数。POST 和 PATCH 请求使用 {"index": N} 设置位置。 正整数 1
last_updated 此规则上次更改的时间。 日期字符串 2023-05-02T12:06:51.796286Z
created_at 此规则创建的时间。 日期字符串 2023-05-02T12:06:51.796286Z

您可以通过在端点管理中导出架构,或使用 API 查找端点的操作 ID。

列出顺序规则

使用 GET 命令列出规则。

cURL commandbash
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/seqrules"

添加单个顺序规则

使用 POST 命令创建单个规则。

这会在所有现有规则中添加一条规则。如果省略 position,API 会将规则追加到末尾。要将其插入特定位置,请将从一开始计数的请求字段设为 {"index": N}。处于该位置及其后的现有规则会依次后移。

响应将反映已写入的规则及其 ID。如果规则有任何不妥之处,将提供一个指向该问题的 json 路径的适当错误消息。

Example using cURLbash
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/seqrules/rules" \
--header "Content-Type: application/json" \
--data '{
  "title": "string",
  "kind": "block",
  "action": "block",
  "sequence": [
    "0d9bf70c-92e1-4bb3-9411-34a3bcc59003",
    "b704ab4d-5be0-46e0-9875-b2b3d1ab42f9"
  ],
  "position": {
    "index": 1
  }
}'

添加多个顺序规则

使用 PUT 命令批量设置新规则。

这将覆盖任何现有规则,并将其替换为正文中指定的规则。为 rules 设置空数组将删除所有规则。

rules 数组中对象的顺序决定规则顺序,从位置 1 开始。请勿在单个批量规则对象中包含 position。

响应将反映已写入的规则及其 ID。如果规则有任何不妥之处,将提供一个指向该问题的 json 路径的适当错误消息。

Example using cURLbash
curl --request PUT "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/seqrules" \
--header "Content-Type: application/json" \
--data '{
  "rules": [
    {
      "title": "<RULE_TITLE>",
      "kind": "block",
      "action": "block",
      "sequence": [
        "0d9bf70c-92e1-4bb3-9411-34a3bcc59003",
        "b704ab4d-5be0-46e0-9875-b2b3d1ab42f9"
      ]
    }
  ]
}'

删除规则

使用 DELETE 命令及其规则 ID 来删除规则。

cURL commandbash
curl --request DELETE "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/seqrules/rules/d4909253-390f-4956-89fd-92a5b0cd86d8"

这篇文档对您有帮助吗?