版本 2.4.8 · 最新
WAF 规则库 waf-rules
主控下发的 WAF 规则包版本、各节点对齐情况与防护清单(付费功能 rules_update;没开通时节点用内置 23 条)。
点击任一接口,右侧显示对应的调用示例。
运维与系统鉴权: 用户2 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/waf-rules/protections防护清单
鉴权: 用户
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
q | string | 搜索词:规则号、标题、产品名或漏洞编号(如 ThinkPHP、CVE-2021-44228)。 |
class | WafRuleClass | 分类:general 通用、patch 漏洞补丁、emergency 应急、custom 定制;不传为全部。 |
product_class | WafProductClass | 产品分类:cms、framework 框架、middleware 中间件、component 组件、other 其他(没有产品的规则归其他);按规则涉及产品里任一个的分类筛;不传为全部。可选分类与各自条数见返回的 product_classes。 |
stack | WafStack[] | 技术栈,可重复传多个(任一即可);不传为全部。可选项与各自条数见返回的 categories.stacks。 |
attack | WafAttack[] | 攻击方式,可重复传多个(任一即可);不传为全部。与 stack 同时传时两者都要满足。可选项与各自条数见返回的 categories.attacks。 |
source | string | 来源:builtin 节点内置、package 规则包、custom 服务商自写;不传为全部来源。限定的是整个清单范围(列表、counts、product_classes、categories 同口径)。 |
format | string | csv = 导出筛选后的全部条目为 CSV 附件;不传回 JSON 分页。 |
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
WAF 规则库对象
| 字段 | 类型 | 说明 |
|---|---|---|
added | string | 加入版本(规则号首次出现的规则包版本,版本号即发布日);内置规则为空。 |
attack | WafAttack | 攻击方式:rce 远程代码执行、sqli SQL 注入、xss、lfi 路径穿越、rfi 远程文件包含、protocol 协议异常、scanner 扫描器、other 其他;按规则包里检测规则的攻击类别,语言类(php、java、nodejs)记 rce,没写类别的记 other;规则包里没有检测规则的条目没有攻击方式。 |
builtin | boolean | 从没拉成过规则包,节点用内置 23 条。 |
class | WafRuleClass | 规则分类:general 通用、patch 漏洞补丁、emergency 应急、custom 定制。 |
cves | string[] | 漏洞编号(CVE / CNVD 等)。 |
enabled | boolean | 付费功能 rules_update 是否开通(没开通或到期时停更,已有的一版照常下发)。 |
error | string | 最近一轮没换上最新版的原因(只给管理员)。 |
halt | string | 授权已过期、停用或超管长时间不可达而停止更新的原因(只给管理员;不是故障,与 error 分开;没有停更时不出现)。 |
id | integer | 规则号(开发方 94xxxx,定制 990000–999999)。 |
latest_version | string | 授权里最新的规则包版本(只给管理员;与 version 不同表示还没换上)。 |
level | string | 生效的最低防护等级:basic 基础、standard 标准、strict 严格。 |
nodes | WafRulesNodes | 节点对齐情况(按心跳回报的在用规则包比当前版;只给管理员)。 |
observe_days_left | integer | 观察中剩余天数(不足一天按一天);只在 status=observing 时有。 |
product_class | WafProductClass | 产品分类:cms、framework 框架、middleware 中间件、component 组件、other 其他;按规则涉及的产品名归类,规则涉及多个产品时取第一个不是 other 的分类,没有产品的规则为 other。 |
products | string[] | 涉及产品。 |
rules | integer | 当前规则条数(builtin 时为 23)。 |
sha256 | string | 当前规则包清单的 sha256;builtin 时不给。 |
source | string | builtin 节点内置、package 规则包、custom 服务商自写(990000–999999)。 |
stack | WafStack | 技术栈:php、java、nodejs、python、dotnet;规则包标了用标的,否则按攻击类别里的语言类(php、java、nodejs)推;推不出的规则没有技术栈。 |
status | string | 处置状态:block 拦截;observing 观察中(新规则先只记录,命中在 WAF 事件里带「仅观察 · 新规则」)。内置、应急规则与观察天数为 0 时恒为 block。 |
synced_at | string | 最近一轮核对时间。 |
title | string | 防护对象;内置规则为规则名。 |
title_en | string | 防护对象英文。 |
type | string | 类型(如 远程代码执行);内置规则为攻击类别(如 sqli)。 |
version | string | 当前规则包版本(如 2026.10.19);builtin 时为空。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}