查询自定义数据参数¶

1. 接口描述¶

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

describeParameter 用于查询创建/更新自定义数据集合时可选用的类型列表（dataListClass）。返回结果合并 Web 应用防火墙与 HTTP DDoS（NLA）支持列表匹配的字段，并按 value 去重。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

本接口无业务请求参数。

3. 示例¶

示例1 查询可选数据集合类型¶

输入示例¶

GET /prod-api/waf/wafv3/dataList/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 DescribeDataListParameterTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/waf/wafv3/dataList/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/dataList/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": {
    "dataListClass": [
      {
        "label": "IP",
        "value": "IP_SRC"
      },
      {
        "label": "主机名",
        "value": "HOST"
      },
      {
        "label": "URI",
        "value": "REQUEST_URI"
      },
      {
        "label": "用户代理",
        "value": "USER_AGENT"
      },
      {
        "label": "REFERER",
        "value": "REFERER"
      },
      {
        "label": "X-Forwarded-For",
        "value": "X_FORWARDED_FOR"
      },
      {
        "label": "Path",
        "value": "URI"
      },
      {
        "label": "JA4",
        "value": "JA4"
      },
      {
        "label": "ASN",
        "value": "ASN"
      },
      {
        "label": "ASN_ORG",
        "value": "ASN_ORG"
      }
    ]
  }
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Object	参数数据
data.dataListClass	Array	可选数据集合类型列表
data.dataListClass[].label	String	展示名称。示例值：`IP`
data.dataListClass[].value	String	类型取值，创建/更新时作为 `dataListClass` 传入，支持以下值： `IP_SRC`：IP `HOST`：主机名 `REQUEST_URI`：URI `USER_AGENT`：用户代理 `REFERER`：REFERER `X_FORWARDED_FOR`：X-Forwarded-For `URI`：Path `JA4`：JA4 `ASN`：ASN `ASN_ORG`：ASN_ORG 示例值：`IP_SRC`

5. 错误码¶

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