查询 IP 获取规则集合¶

1. 接口描述¶

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

describeRealIPRules 用于分页查询当前账号下的真实 IP 获取规则集合，支持按规则名称、域名筛选，并返回规则内容、关联域名及更新时间。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
pageNum	是	Integer	当前页数示例值：`1`
pageSize	是	Integer	每页显示条目个数示例值：`10`
filters	否	Array	搜索条件列表
filters.label	否	String	搜索字段，支持以下值： `ruleName`：规则名称 `domain`：域名示例值：`ruleName`
filters.value	否	Array of String	搜索值。传入单个值为模糊搜索，多个值为精确搜索示例值：`["text"]`

3. 示例¶

示例1 分页查询 IP 获取规则¶

输入示例¶

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": []
}

代码调用¶

请将 {登录域名}、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 DescribeRealIPRulesTest {

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

        String requestBody = "{"
                + "\"pageNum\":1,"
                + "\"pageSize\":10,"
                + "\"filters\":[]"
                + "}";

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

    requestBody := []byte(`{
  "pageNum": 1,
  "pageSize": 10,
  "filters": []
}`)

    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))
}

输出示例¶

{
  "total": 1,
  "rows": [
    {
      "ruleId": "23",
      "ruleName": "text",
      "rules": "[{\"method\":\"UNTRUSTED_IP\",\"value\":\"1.1.1.2\\n3.3.3.3\"},{\"method\":\"HTTP_HEADER\",\"value\":\"2\"},{\"method\":\"X_FORWARDED_FOR_LEFT\",\"value\":\"1\"},{\"method\":\"SOCKET\",\"value\":\"\"}]",
      "updateTime": "2026-02-25 17:15:13",
      "domains": [
        {
          "label": "waf2.demo.com",
          "value": "215"
        },
        {
          "label": "waf4.demo.com",
          "value": "216"
        },
        {
          "label": "gbp.demo.com.cn",
          "value": "219"
        }
      ]
    }
  ],
  "code": 200,
  "msg": "成功"
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
total	Integer	符合条件的总条数。示例值：`1`
rows	Array	规则集合列表
rows[].ruleId	String	规则集 ID。编辑时写入编辑 IP 获取规则集合请求体；新增时不写示例值：`23`
rows[].ruleName	String	规则名称。示例值：`text`
rows[].rules	String	规则集内容，JSON 字符串。字段含义见 RealIPRuleModel 示例值：`[{"method":"SOCKET","value":""}]`
rows[].updateTime	String	最后更新时间，格式 `yyyy-MM-dd HH:mm:ss` 示例值：`2026-02-25 17:15:13`
rows[].domains	Array	关联域名列表
rows[].domains[].label	String	域名。示例值：`waf2.demo.com`
rows[].domains[].value	String	域名 ID。示例值：`215`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
参数异常	`filters.label` 不是 `ruleName` / `domain`