查询条件参数¶

1. 接口描述¶

接口请求路径：GET /prod-api/waf/wafv3/limit/rules/describeParameter

describeParameter 返回配置自定义限速规则时可用的匹配字段（targets）与动作元数据（actions），供前端渲染条件表单、相同特征下拉与动作选项。完整枚举以接口实时返回为准。

说明：接口返回的 actions 与自定义控制规则共用枚举，但保存限速规则时仅允许 DENY / LOG，并须额外配置 limitAccess、limitTime、parameters.behavior（见编辑自定义限速规则）。

Token 获取方式见密钥鉴权。

2. 输入参数¶

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

本接口无业务请求参数。

3. 示例¶

示例1 查询条件与动作元数据¶

输入示例¶

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

代码调用¶

请将 {登录域名}、token 替换为实际值。

JavaGo

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeLimitParameterTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/waf/wafv3/limit/rules/describeParameter";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet httpGet = new HttpGet(url);
            httpGet.setHeader("Authorization", "Bearer " + token);

            try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/waf/wafv3/limit/rules/describeParameter"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    req, err := http.NewRequest(http.MethodGet, url, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例（节选）¶

{
  "msg": "成功",
  "code": 200,
  "data": {
    "targets": [
      {
        "name": "IP",
        "target": "IP_SRC",
        "value": "IP_SRC",
        "operators": ["IP_IN_LIST", "NOT_IP_IN_LIST"],
        "valueModelMap": {
          "IP_IN_LIST": { "type": "data_list", "values": [] }
        },
        "optionals": [],
        "remark": ""
      },
      {
        "name": "URI",
        "target": "REQUEST_URI",
        "value": "REQUEST_URI",
        "operators": ["EQ", "BEGINS_WITH", "ENDS_WITH", "IN_LIST"],
        "remark": "例如：/contact?page=1234"
      }
    ],
    "actions": [
      {
        "name": "拦截",
        "value": "DENY",
        "operators": ["log"],
        "parameters": null
      },
      {
        "name": "仅记录不拦截",
        "value": "LOG",
        "operators": ["log"],
        "parameters": null
      }
    ]
  }
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Object	元数据
data.targets	Array	匹配字段列表，同时用于条件与 `characteristics` 的 `target`
data.actions	Array	动作列表（保存时仅用 `DENY` / `LOG`）

匹配字段 `data.targets[]`¶

参数名称	类型	描述
name	String	中文展示名。示例值：`IP`
target	String	维度编码。示例值：`IP_SRC`
value	String	同 `target` 或辅助标识
operators	Array of String	该字段可用运算符编码列表
valueModelMap	Object	以运算符为键的取值 UI 模型（如 `data_list` / `multiple_group`）
optionals	Array	可选枚举值；可能为空
groupList	Array	分组下拉（如国家/地区）；视字段而定
remark	String	填写提示

常见 target 一览（与自定义控制规则相同）：

target	name	常用 operators
`IP_SRC`	IP	`IP_IN_LIST`、`NOT_IP_IN_LIST`
`COUNTRY_CODE`	国家/地区	`IN`、`NOT_IN`
`HOST`	主机名	`EQ`、`CONTAINS`、`MATCHES`、`IN_LIST` 等
`ARGS` / `ARGS_NAMES` / `ARGS_POST` / `ARGS_POST_NAMES`	查询/POST 参数相关	`EQ`、`CONTAINS`、`MATCHES` 等
`REQUEST_URI`	URI	`EQ`、`BEGINS_WITH`、`ENDS_WITH`、`IN_LIST` 等
`REQUEST_COOKIES`	COOKIES	`EQ`、`CONTAINS`、`MATCHES` 等
`REQUEST_HEADERS` / `REQUEST_HEADERS_NAMES`	请求头 / 请求头名	含 `EXIST` / `NOT_EXIST`
`CHECK_REQUEST_HEADERS_NAMES`	检查请求头名	`INT_EQ`（`0`/`1`）
`USER_AGENT`	用户代理	`EQ`、`CONTAINS`、`IN_LIST` 等
`REQUEST_PROTOCOL`	HTTP 版本	`IN`、`NOT_IN` 等
`REQUEST_METHOD`	请求方法	`IN`、`NOT_IN`
`REFERER`	REFERER	`EQ`、`CONTAINS`、`IN_LIST` 等
`X_FORWARDED_FOR`	X-Forwarded-For	同上

常用运算符：EQ / NOT_EQ、IN / NOT_IN、CONTAINS / NOT_CONTAINS、MATCHES / NOT_MATCHES、BEGINS_WITH / ENDS_WITH、IN_LIST / NOT_IN_LIST、IP_IN_LIST / NOT_IP_IN_LIST、EXIST / NOT_EXIST、INT_EQ。

执行动作 `data.actions[]`¶

参数名称	类型	描述
name	String	中文展示名
value	String	动作编码
operators	Array of String	日志选项
parameters	Object / null	附加参数元数据

限速规则保存时可用：

value	name	说明
`DENY`	拦截	须配 `limitAccess` / `limitTime` / `behavior`
`LOG`	仅记录不拦截	同上

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限