跳转至

编辑 IP 获取规则集合

1. 接口描述

接口请求路径：POST /prod-api/waf/realIP/modifyRealIPRules

modifyRealIPRules 用于创建或编辑真实 IP 获取规则集合。新增时请求体中不写 ruleId；编辑时必填 ruleId（取自 查询 IP 获取规则集合 返回的 rows[].ruleId）。关联域名须属于当前账号，可选域名见 查询可选域名列表。

Token 获取方式见 密钥鉴权。

2. 输入参数

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

参数名称 必选 类型 描述
domains 是 [DomainItem] 关联域名列表
ruleName 是 String 规则名称，长度 1–100。示例值：demo
rules 是 [RealIPRuleModel] 规则集列表
ruleId 否 Long 规则集 ID。新增时请求体中不写该参数；编辑时必填。示例值：25

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值：200
msg String 提示信息。示例值：成功
data Object 规则集合数据
data.ruleId Long 规则集 ID。新增成功后由接口返回；编辑时与请求一致。示例值：25
data.ruleName String 规则名称。示例值：demo
data.domains [DomainItem] 关联域名列表
data.rules [RealIPRuleModel] 规则集列表

4. 示例

示例1 新增 IP 获取规则集合

输入示例

{
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    },
    {
      "label": "gbp.demo.com.cn",
      "value": 219
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}

代码调用

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

curl -X POST 'https://{登录域名}/prod-api/waf/realIP/modifyRealIPRules' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    },
    {
      "label": "gbp.demo.com.cn",
      "value": 219
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}'

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

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

        String requestBody = "{"
                + "\"domains\":["
                + "{\"label\":\"waf2.demo.com\",\"value\":215},"
                + "{\"label\":\"gbp.demo.com.cn\",\"value\":219}"
                + "],"
                + "\"ruleName\":\"demo\","
                + "\"rules\":[{\"method\":\"SOCKET\",\"value\":\"\"}]"
                + "}";

        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/realIP/modifyRealIPRules"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    },
    {
      "label": "gbp.demo.com.cn",
      "value": 219
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}`)

    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": {
    "ruleName": "demo",
    "domains": [
      {
        "label": "waf2.demo.com",
        "value": 215
      },
      {
        "label": "gbp.demo.com.cn",
        "value": 219
      }
    ],
    "ruleId": 25,
    "rules": [
      {
        "method": "SOCKET",
        "value": ""
      }
    ]
  }
}

示例2 编辑 IP 获取规则集合

输入示例

{
  "ruleId": 25,
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    },
    {
      "label": "gbp.demo.com.cn",
      "value": 219
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}

代码调用

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

curl -X POST 'https://{登录域名}/prod-api/waf/realIP/modifyRealIPRules' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "ruleId": 25,
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    },
    {
      "label": "gbp.demo.com.cn",
      "value": 219
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}'

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

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

        String requestBody = "{"
                + "\"ruleId\":25,"
                + "\"domains\":["
                + "{\"label\":\"waf2.demo.com\",\"value\":215},"
                + "{\"label\":\"gbp.demo.com.cn\",\"value\":219}"
                + "],"
                + "\"ruleName\":\"demo\","
                + "\"rules\":[{\"method\":\"SOCKET\",\"value\":\"\"}]"
                + "}";

        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/realIP/modifyRealIPRules"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "ruleId": 25,
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    },
    {
      "label": "gbp.demo.com.cn",
      "value": 219
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}`)

    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": {
    "ruleName": "demo",
    "domains": [
      {
        "label": "waf2.demo.com",
        "value": 215
      },
      {
        "label": "gbp.demo.com.cn",
        "value": 219
      }
    ],
    "ruleId": 25,
    "rules": [
      {
        "method": "SOCKET",
        "value": ""
      }
    ]
  }
}

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
IP地址格式错误 UNTRUSTED_IP 中存在非法 IPv4/CIDR
IP地址数量不能大于100个 UNTRUSTED_IP 按换行拆分后超过 100 个
X_FORWARDED_FOR_LEFT和X_FORWARDED_FOR_RIGHT的值必须为正整数 对应 value 不是正整数
HTTP_HEADER的值不能为空 HTTP_HEADER 的 value 为空
最大长度为100 ruleName 长度不在 1–100 范围内
规则不存在 编辑时 ruleId 对应规则不存在

6. 数据模型

DomainItem

关联域名项。

参数名称 必选 类型 描述
label 是 String 域名。示例值：waf2.demo.com
value 是 Integer 域名 ID。示例值：215

RealIPRuleModel

真实 IP 获取规则项。

参数名称 必选 类型 描述
method 是 String 获取方式。取值：SOCKET（从 socket 连接获取 IP，value 可空）、X_FORWARDED_FOR_LEFT（从 X-Forwarded-For 左起第 N 个 IP，value 正整数）、X_FORWARDED_FOR_RIGHT（从 X-Forwarded-For 右起第 N 个 IP，value 正整数）、HTTP_HEADER（从指定 HTTP 头获取 IP，value 不能为空）、UNTRUSTED_IP（未信任 IP 列表，value 为换行分隔的 IPv4/CIDR，最多 100 个）。示例值：SOCKET
value 否 String 与 method 对应的取值。SOCKET 时可为空字符串；X_FORWARDED_FOR_LEFT / X_FORWARDED_FOR_RIGHT 为正整数；HTTP_HEADER 为请求头名称；UNTRUSTED_IP 为换行分隔的 IP/CIDR。示例值：1