WAF3.0 API

GET 查询条件参数

GET /prod-api/waf/wafv3/limit/rules/describeParameter

获取创建/编辑自定义限速规则时所需的元数据：

• targets：匹配条件可选的「匹配对象」、支持的「运算符（operators）」及取值 UI 模型（valueModelMap）；
• actions：规则命中后的动作枚举（限速规则实际仅使用其中部分）；
• 编辑时 characteristics 的 target 取值与 targets[].target 相同。

无请求体。对接方应先调用本接口，再组装 编辑自定义限速规则 中的 rules.conditions、rules.characteristics 与 rules.action。

返回结构与 自定义控制规则 - 查询条件参数 的 data 基本一致（targets、actions 等字段含义相同）。下文仅说明限速规则侧的差异与用法。

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是	鉴权	Bearer Token

返回示例（结构节选）

200 Response

{
  "msg": "成功",
  "code": 200,
  "data": {
    "targets": [
      {
        "target": "IP_SRC",
        "name": "IP",
        "value": "IP_SRC",
        "operators": ["IP_IN_LIST", "NOT_IP_IN_LIST"],
        "valueModelMap": {
          "IP_IN_LIST": { "type": "data_list", "values": [] }
        }
      }
    ],
    "actions": [
      { "value": "DENY", "name": "拦截", "parameters": ["log"] },
      { "value": "LOG", "name": "仅记录不拦截", "parameters": ["log"] }
    ]
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	说明
» msg	string	提示信息
» code	integer	200 表示成功
» data	object	元数据，见下表

data.targets[]（用于 conditions 与 characteristics）

字段	说明
target	提交时的匹配对象/特征编码（如 IP_SRC）
name	中文展示名
operators	该对象在匹配条件中可用的运算符列表
valueModelMap	各运算符对应的取值控件类型（如 data_list、multiple_group）
groupList	国家/地区类（COUNTRY_CODE）的分组选项

组装 conditions[] 时：target、operator、values 须与本接口返回定义一致。values 填法（数据集合 ID、国家代码等）参见 自定义规则 - 查询条件参数 及 查询自定义限速规则 中的条件说明。

组装 characteristics[] 时：仅需 target + name（无 operator / values），target 从本接口 targets 中选择。

data.actions[]（限速规则实际用法）

返回中可能包含多种动作，但 编辑自定义限速规则 仅支持：

value	name（示例）	限速规则中的用法
DENY	拦截	超限时阻断请求
LOG	仅记录不拦截	超限时只记日志

须同时配置 limitAccess、limitTime、parameters.behavior（及 all 模式下的 duration），不能仅传 actions 中的 parameters 数组（与自定义规则的 rules.action.parameters 结构不同）。

对接流程建议

1. GET describeParameter → 缓存 targets / actions。
2. 用户配置相同特征、匹配条件、限速阈值与动作。
3. POST modifyLimitRule 提交完整 rules 对象。
4. 列表展示调用 列出自定义限速控制规则；单条回显调用 查询自定义限速规则。

更完整的 targets 字段说明与 operator 对照表，见 自定义控制规则 - 查询条件参数。