WAF3.0 API

POST 列出托管规则组

POST /prod-api/waf/wafv3/custody/rules/describeCustodyRuleGroups

按 策略组 ID（wafId） 分页查询 OWASP CRS 托管规则组列表。每条记录对应一类检测能力（如协议检测、SQL 注入、PHP 攻击等）。

• 点击某规则组后，用 groupId 调用 列出托管规则明细 查看组内单条规则。
• 开关整个规则组请用 更新托管规则组状态。
• CRS 基础设置（允许方法、Content-Type 等）见 列出 CRS 设置规则，与本接口无关。

Body 请求参数

{
  "pageNum": 1,
  "pageSize": 20,
  "wafId": 22,
  "params": {}
}

字段	类型	必选	说明
wafId	integer(int64)	是	策略组 ID
pageNum	integer	是	页码，从 1 开始
pageSize	integer	是	每页条数
params	object	否	扩展参数，一般传 {}

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是	鉴权	Bearer Token
body	body	object	是	请求体	见上文

返回示例

200 Response

{
  "total": 10,
  "rows": [
    {
      "groupId": 901,
      "groupName": "REQUEST-INITIALIZATION",
      "groupMessage": "安装检测",
      "status": "ON"
    },
    {
      "groupId": 911,
      "groupName": "REQUEST-METHOD-ENFORCEMENT",
      "groupMessage": "请求方法检测规则",
      "status": "ON"
    }
  ],
  "code": 200,
  "msg": "成功"
}

返回结果

状态码	状态码含义	说明
200	OK	成功
401	Unauthorized	未授权
403	Forbidden	无权限

返回数据结构

状态码 200

名称	类型	必选	说明
total	integer	是	符合条件的规则组总数
rows	[object]	是	当前页规则组列表
code	integer	是	200 表示成功
msg	string	是	提示信息

rows[] 每条规则组

字段	类型	说明
groupId	integer	规则组 ID；列出托管规则明细 请求体中的 groupId、 更新托管规则组状态 的 group_id 均使用此值
groupName	string	规则组英文标识（CRS 分类名），如 REQUEST-PROTOCOL-ENFORCEMENT
groupMessage	string	规则组中文说明，供控制台展示
status	string	该组在当前 wafId 下的启用状态，见下表

status 取值

值	含义
ON	已启用该规则组
OFF	已关闭该规则组

与其它接口的配合

1. 列出规则组：POST describeCustodyRuleGroups → 得到 rows[].groupId、status。
2. 查看组内规则：POST describeCustodyRuleList，Body 传 wafId + 选中的 groupId。
3. 开关单条规则：GET changeCustodyRuleStatus（ruleId 来自规则明细列表）。
4. 开关整个规则组：GET changeCustodyRuleGroupStatus（group_id 为本接口的 groupId）。

describeCustodyRuleGroups (规则组)
        │
        ├─► describeCustodyRuleList (组内规则明细, 传 groupId)
        │
        └─► changeCustodyRuleGroupStatus (整组 ON/OFF)