WAF3.0 API¶

POST 列出自定义控制规则¶

POST /prod-api/waf/wafv3/custom/rules/describeCustomRules

按 策略组 ID（wafId） 分页查询该策略组下的自定义控制规则列表。返回每条规则的摘要信息（匹配对象、处置动作、排序等），用于控制台列表展示；编辑单条规则详情请调用查询自定义控制规则。

Body 请求参数

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

字段	类型	必选	说明
`wafId`	integer(int64)	是	策略组 ID，指定要查询哪一组 WAF 规则
`pageNum`	integer	是	页码，从 1 开始，默认 1
`pageSize`	integer	是	每页条数，默认 10
`params`	object	否	扩展查询参数，一般传 `{}` 即可

userId 由服务端根据登录态自动填充，请求体中无需传递。

请求参数¶

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是	鉴权	Bearer Token
body	body	DescribeCustomRulesVO	是	DescribeCustomRulesVO	见上文 Body 字段说明

返回示例

200 Response

{
  "total": 4,
  "rows": [
    {
      "customRuleId": 61,
      "ruleMessage": "sql注入攻击 包含",
      "status": "enable",
      "targets": [
        {
          "name": "检查请求头名",
          "value": "CHECK_REQUEST_HEADERS_NAMES"
        },
        {
          "name": "IP",
          "value": "IP_SRC"
        }
      ],
      "ruleClass": "custom",
      "action": "拦截",
      "updateTime": "2025-09-08 18:08:01",
      "sort": 1
    }
  ],
  "code": 200,
  "msg": "成功"
}

返回结果¶

状态码	状态码含义	说明	数据模型
200	OK	成功	`TableDataInfo`
401	Unauthorized	未授权	-
403	Forbidden	无权限	-

返回数据结构¶

状态码 200

名称	类型	必选	中文名	说明
» total	integer	是	总条数	符合 `wafId` 条件的规则总数
» rows	[object]	是	规则列表	当前页数据，按 `sort` 升序排列
»» customRuleId	integer(int64)	是	规则 ID	编辑、删除、查询详情时使用
»» ruleMessage	string	是	规则描述	列表展示的说明文字
»» status	string	是	启用状态	见下表 status
»» targets	[object]	是	匹配对象	规则条件涉及的「检查项」摘要
»»» name	string	是	检查项名称	中文展示名，如「IP」「Uri」
»»» value	string	是	检查项编码	与编辑自定义控制规则中 `rules.conditions[].target` 一致，如 `IP_SRC`、`REQUEST_URI`
»» ruleClass	string	是	规则类别	`custom`：用户自定义；`default`：系统默认
»» action	string	是	处置动作	中文展示名，见下表 action
»» updateTime	string	是	更新时间	格式 `yyyy-MM-dd HH:mm:ss`
»» sort	integer	是	排序号	数值越小越靠前；调整顺序见更新规则排序
» code	integer	是	状态码	业务状态码，200 表示成功
» msg	string	是	提示信息	如「成功」

status 取值¶

值	含义
`enable`	已启用
`disable`	已关闭

action 常见取值（列表接口返回为中文）¶

展示值	说明
拦截	命中后阻断请求
仅记录不拦截	命中后只记日志，不阻断
重定向	命中后按规则配置重定向
跳过规则	命中后跳过后续指定类型规则
加白规则ID	命中后对指定规则 ID 加白

targets.value 常见编码（与 `name` 对应）¶

value	name（示例）
`IP_SRC`	IP
`REQUEST_URI`	Uri
`REQUEST_PROTOCOL`	请求协议 / HTTP版本
`CHECK_REQUEST_HEADERS_NAMES`	检查请求头名
`REQUEST_HEADERS_NAMES`	请求头名
`HOST`	主机名

完整匹配对象编码见查询条件参数或编辑规则接口文档。

数据模型¶

DescribeCustomRulesVO¶

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

DescribeCustomRulesVO

属性¶

名称	类型	必选	中文名	说明
wafId	integer(int64)	是	策略组 ID	必填
pageNum	integer(int32)	否	页码	默认 1
pageSize	integer(int32)	否	每页条数	默认 10
params	object	否	扩展参数	预留，一般传 `{}`

ResultCustomRulesVO¶

{
  "customRuleId": 61,
  "ruleMessage": "sql注入攻击 包含",
  "status": "enable",
  "targets": [{ "name": "IP", "value": "IP_SRC" }],
  "ruleClass": "custom",
  "action": "拦截",
  "updateTime": "2025-09-08 18:08:01",
  "sort": 1
}

ResultCustomRulesVO（rows 数组元素）

属性¶

名称	类型	必选	中文名	说明
customRuleId	integer(int64)	是	规则 ID	-
ruleMessage	string	是	规则描述	-
status	string	是	启用状态	`enable` / `disable`
targets	MapByNameValue	是	匹配对象摘要	仅含本规则用到的检查项
ruleClass	string	是	规则类别	`custom` / `default`
action	string	是	处置动作	中文展示名
updateTime	string	是	更新时间	`yyyy-MM-dd HH:mm:ss`
sort	integer	是	排序号	-

MapByNameValue¶

{
  "name": "IP",
  "value": "IP_SRC"
}

MapByNameValue（targets 元素）

属性¶

名称	类型	必选	中文名	说明
name	string	是	展示名称	由 `value` 自动翻译，供界面显示
value	string	是	检查项编码	编辑规则时作为 `target` 使用