WAF3.0 API¶

POST 列出自定义限速控制规则¶

POST /prod-api/waf/wafv3/limit/rules/describeLimitRules

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

Body 请求参数

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

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

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

请求参数¶

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

返回示例

200 Response

{
  "total": 2,
  "rows": [
    {
      "limitRuleId": 15,
      "ruleMessage": "单IP访问限速",
      "status": "enable",
      "targets": [
        { "name": "IP", "value": "IP_SRC" },
        { "name": "Uri", "value": "REQUEST_URI" }
      ],
      "action": "拦截",
      "updateTime": "2025-09-08 18:08:01",
      "sort": 1
    }
  ],
  "code": 200,
  "msg": "成功"
}

返回结果¶

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

返回数据结构¶

状态码 200

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

status 取值¶

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

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

展示值	说明
拦截	超限时阻断请求（对应编码 `DENY`）
仅记录不拦截	超限时只记日志（对应编码 `LOG`）

完整匹配对象编码见查询条件参数。