列出防篡改域名¶

1. 接口描述¶

接口请求路径：POST /prod-api/waf/wafv3/falsify/describeFalsifyDomainList

describeFalsifyDomainList 用于分页查询指定 WAF 套餐下已接入的域名列表，返回各域名的防篡改开关状态、规则条数，以及后续配置所需的 domainId、advanceId。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
pageNum	是	Integer	当前页数示例值：`1`
pageSize	是	Integer	每页显示条目个数示例值：`10`
oid	是	String	WAF 套餐/订单 ID 示例值：`20240412279097884616`
filters	否	Array	搜索条件列表；不筛选时传 `[]`
filters.label	否	String	搜索字段，支持以下值： `domainName`：域名（模糊匹配） `port`：监听端口示例值：`domainName`
filters.value	否	Array of String	搜索值。`domainName` 为模糊搜索；`port` 单值为精确匹配，多值为 `IN` 查询示例值：`["waf2.ruisuyun.com"]`

3. 示例¶

示例1 分页查询防篡改域名¶

输入示例¶

{
  "pageNum": 1,
  "pageSize": 10,
  "oid": "20240412279097884616",
  "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 DescribeFalsifyDomainListTest {

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

        String requestBody = "{"
                + "\"pageNum\":1,"
                + "\"pageSize\":10,"
                + "\"oid\":\"20240412279097884616\","
                + "\"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/wafv3/falsify/describeFalsifyDomainList"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "pageNum": 1,
  "pageSize": 10,
  "oid": "20240412279097884616",
  "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": 42,
  "rows": [
    {
      "domainId": 215,
      "advanceId": 212,
      "domainName": "waf2.ruisuyun.com",
      "port": "0",
      "ruleCount": 0,
      "falsify": 1
    },
    {
      "domainId": 219,
      "advanceId": 216,
      "domainName": "gbp.gloria.com.cn",
      "port": "21000",
      "ruleCount": 0,
      "falsify": 0
    }
  ],
  "code": 200,
  "msg": "成功"
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
total	Integer	符合条件的总条数。示例值：`42`
rows	Array	域名列表
rows[].domainId	Long	域名 ID。示例值：`215`
rows[].advanceId	Long	域名高级配置 ID。示例值：`212`
rows[].domainName	String	域名。示例值：`waf2.ruisuyun.com`
rows[].port	String	监听端口；`"0"` 通常表示默认端口。示例值：`0`
rows[].ruleCount	Integer	已配置的防篡改规则条数。示例值：`0`
rows[].falsify	Integer	防篡改总开关，支持以下值： `1`：已开启 `0`：已关闭示例值：`1`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
oid不能为空	未传 `oid`