更新自定义数据集合¶

1. 接口描述¶

接口请求路径：POST /prod-api/waf/wafv3/dataList/modifyCustomDataList

modifyCustomDataList 用于创建或更新自定义数据集合。不传 dataListId（或传 0）时为创建；传入有效 dataListId 时为更新（更新时组名称不可修改）。单次最多 10000 个数据项；类型为 IP_SRC 时，每项须为合法 IPv4 地址或 CIDR。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
listName	是	String	组名称，仅允许小写字母、数字和下划线。创建时必填；更新时即使传入也不会生效示例值：`block_ip_list`
dataListClass	是	String	数据集合类型，支持以下值： `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`
data	否	String	项目内容，多个值以英文逗号分隔，最多 10000 项。`IP_SRC` 时须为合法 IPv4 或 CIDR 示例值：`1.1.1.1,2.2.2.0/24`
message	否	String	备注，最长 200 个字符
dataListId	否	Integer	数据集合 ID。创建时不传或传 `0`；编辑时必填示例值：`63`

3. 示例¶

示例1 创建 IP 类型数据集合¶

输入示例¶

{
  "data": "1.1.1.1",
  "dataListClass": "IP_SRC",
  "listName": "block_ip_list",
  "message": "拦截来源 IP"
}

代码调用¶

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

JavaGo

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ModifyCustomDataListTest {

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

        String requestBody = "{"
                + "\"data\":\"1.1.1.1\","
                + "\"dataListClass\":\"IP_SRC\","
                + "\"listName\":\"block_ip_list\","
                + "\"message\":\"拦截来源 IP\""
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                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 (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

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

    requestBody := []byte(`{
  "data": "1.1.1.1",
  "dataListClass": "IP_SRC",
  "listName": "block_ip_list",
  "message": "拦截来源 IP"
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    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": 63
}

示例2 更新已有数据集合¶

输入示例¶

{
  "dataListId": 63,
  "data": "1.1.1.1,8.8.8.8",
  "dataListClass": "IP_SRC",
  "listName": "block_ip_list",
  "message": "更新拦截 IP"
}

输出示例¶

{
  "msg": "成功",
  "code": 200,
  "data": 63
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Integer	数据集合 ID。示例值：`63`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
[listName]不能为空	未传 `listName`
状态[listName]只允许使用小写字母、数字和下划线	`listName` 格式不合法
类别不能为空	未传 `dataListClass`
描述不能超过200个字符	`message` 超过 200 字符
输入内容[{dataListClass}]不是一个有效的数据集合类别	`dataListClass` 不在可选类型列表中
更新失败: The dateListId does not exist.	编辑时 `dataListId` 不存在
更新失败：数据集合已被资源关联，无法修改数据集合类型	已被规则/防火墙关联时不可改类型
最多只能添加10000个数据单位	`data` 拆分后超过 10000 项
输入内容[{ip}]不是一个正确的ip地址	`IP_SRC` 类型下存在非法 IP/CIDR
更新失败，请确认数据列表ID是否正确	更新目标不存在
更新失败，只能更新类型为自定义的数据列表	目标不是自定义类型（如情报库）