跳转至

查询自定义数据集合详情

1. 接口描述

接口请求路径:GET /prod-api/waf/wafv3/dataList/describeCustomData/{dataListId}

describeCustomData 用于按 ID 查询当前账号下指定自定义数据集合的详情,包括组名称、类型与项目数据内容。

Token 获取方式见 密钥鉴权

2. 输入参数

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

参数名称 必选 类型 描述
dataListId Integer Path 参数。数据集合 ID
示例值:63

3. 示例

示例1 查询数据集合详情

输入示例

GET /prod-api/waf/wafv3/dataList/describeCustomData/63

代码调用

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

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

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/waf/wafv3/dataList/describeCustomData/63";
        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/describeCustomData/63"
    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": {
    "dataListId": 63,
    "listName": "11",
    "message": "",
    "dataListClass": "IP_SRC",
    "data": "1.1.1.1",
    "dataListClassLabel": null
  }
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
data Object 数据集合详情
data.dataListId Integer 数据集合 ID。示例值:63
data.listName String 组名称。示例值:11
data.message String 备注
data.dataListClass String 数据集合类型。示例值:IP_SRC
data.data String 项目数据,多个值以英文逗号分隔。示例值:1.1.1.1
data.dataListClassLabel String 类型展示名;详情接口可能为 null

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
查询失败,请确认数据列表ID是否正确 dataListId 不存在或不属于当前账号