查询条件参数

1. 接口描述

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

describeParameter 返回配置自定义限速规则时可用的匹配字段（targets）与执行动作（actions）元数据，供前端渲染条件表单、相同特征下拉与动作选项。完整枚举以接口实时返回为准（含当前用户可用的数据集合、国家/地区分组等）。

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

Token 获取方式见 密钥鉴权。

2. 输入参数

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

本接口无业务请求参数。

3. 输出参数

参数名称	类型	描述
code	Integer	状态码。示例值：200
msg	String	提示信息。示例值：成功
data	Object	元数据
data.targets	[TargetMeta]	匹配字段列表
data.actions	[ActionMeta]	执行动作列表

4. 示例

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

输入示例

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

代码调用

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

cURLJavaGo

curl -X GET 'https://{登录域名}/prod-api/waf/wafv3/limit/rules/describeParameter' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx'

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 DescribeParameterTest {

    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": "主机名",
        "target": "HOST",
        "value": "HOST",
        "operators": ["EQ", "NOT_EQ", "CONTAINS", "NOT_CONTAINS", "MATCHES", "NOT_MATCHES", "IN_LIST", "NOT_IN_LIST"],
        "remark": "例如：example.com"
      },
      {
        "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
      }
    ]
  }
}

5. 错误码

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

6. 数据模型

TargetMeta

匹配字段元数据项。

参数名称	类型	描述
name	String	中文展示名。示例值：主机名
target	String	维度编码，写入条件或 characteristics 的 target。示例值：HOST
value	String	同 target 或辅助标识；部分字段可能为空串
operators	Array of String	该字段可用运算符编码列表
valueModelMap	Object	以运算符为键的取值 UI 模型（如 data_list / multiple / multiple_group / select）；可能为空
optionals	Array of String	可选枚举值（如协议、方法、0/1）；可能为空
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、NOT_EQ、CONTAINS、NOT_CONTAINS、MATCHES、NOT_MATCHES、IN_LIST、NOT_IN_LIST
ARGS	查询字符串	EQ、NOT_EQ、CONTAINS、NOT_CONTAINS、MATCHES、NOT_MATCHES
ARGS_NAMES	参数名	同上
ARGS_POST / ARGS_POST_NAMES	POST 参数 / 参数名	同上
REQUEST_URI	URI	EQ、NOT_EQ、CONTAINS、NOT_CONTAINS、BEGINS_WITH、NOT_BEGINS_WITH、ENDS_WITH、NOT_ENDS_WITH、MATCHES、NOT_MATCHES、IN_LIST、NOT_IN_LIST
REQUEST_COOKIES	COOKIES	EQ、NOT_EQ、CONTAINS、NOT_CONTAINS、MATCHES、NOT_MATCHES
REQUEST_HEADERS	请求头	同上；name 填具体头名
REQUEST_HEADERS_NAMES	请求头名	含 EXIST / NOT_EXIST
CHECK_REQUEST_HEADERS_NAMES	检查请求头名	INT_EQ；optionals 为 0（不存在）/ 1（存在）；name 填具体头名
USER_AGENT	用户代理	EQ、NOT_EQ、CONTAINS、NOT_CONTAINS、MATCHES、NOT_MATCHES
REQUEST_PROTOCOL	HTTP 版本	IN、NOT_IN、EQ、NOT_EQ、CONTAINS、NOT_CONTAINS；optionals 含 HTTP/1.0…HTTP/3
REQUEST_METHOD	请求方法	IN、NOT_IN；optionals 含 GET/POST 等
REFERER	REFERER	EQ、NOT_EQ、CONTAINS、NOT_CONTAINS、MATCHES、NOT_MATCHES、IN_LIST、NOT_IN_LIST
X_FORWARDED_FOR	X-Forwarded-For	同上

常用运算符含义：

编码	说明
EQ / NOT_EQ	等于 / 不等于
IN / NOT_IN	属于 / 不属于给定集合
CONTAINS / NOT_CONTAINS	包含 / 不包含
MATCHES / NOT_MATCHES	正则匹配 / 不匹配
BEGINS_WITH / ENDS_WITH	开头 / 末尾匹配（及对应 NOT_*）
IN_LIST / NOT_IN_LIST	在 / 不在数据集合中
IP_IN_LIST / NOT_IP_IN_LIST	IP 在 / 不在数据集合中
EXIST / NOT_EXIST	存在 / 不存在
INT_EQ	整数等于（检查请求头名场景：0/1）

ActionMeta

执行动作元数据项。

参数名称	类型	描述
name	String	中文展示名。示例值：拦截
value	String	动作编码，写入规则 rules.action.action。示例值：DENY
operators	Array of String	日志选项，如 log / nolog
parameters	Object / null	附加参数元数据；多数为 null

限速规则保存时可用动作：

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

保存规则时的限速动作与 behavior/duration 组装方式见 编辑自定义限速规则。