查询可选域名列表

1. 接口描述

接口请求路径：GET /prod-api/waf/realIP/describeDomains

describeDomains 用于查询当前账号下可用于配置真实 IP 获取规则的域名列表，并返回各域名已关联的规则名称（未关联时为空字符串）。

Token 获取方式见 密钥鉴权。

2. 输入参数

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

本接口无业务请求参数。

3. 示例

示例1 查询可选域名

输入示例

GET /prod-api/waf/realIP/describeDomains

代码调用

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

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/waf/realIP/describeDomains";
        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/realIP/describeDomains"
    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": [
    {
      "domainId": 215,
      "domainName": "waf2.demo.com",
      "port": 0,
      "ruleName": ""
    },
    {
      "domainId": 219,
      "domainName": "gbp.demo.com.cn",
      "port": 21000,
      "ruleName": ""
    }
  ]
}

4. 输出参数

参数名称	类型	描述
code	Integer	状态码。示例值：200
msg	String	提示信息。示例值：成功
data	Array	域名列表
data[].domainId	Long	域名 ID。示例值：215
data[].domainName	String	域名。示例值：waf2.demo.com
data[].port	Integer	端口，0 表示默认端口。示例值：0
data[].ruleName	String	已关联的真实 IP 规则名称；未关联时为空字符串。示例值：demo

5. 错误码

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