跳转至

WAF3.0 API

POST 列出防篡改域名

POST /prod-api/waf/wafv3/falsify/describeFalsifyDomainList

分页查询当前 WAF 套餐（oid） 下已接入的域名列表，用于防篡改配置入口：查看各域名的 防篡改开关、规则条数，并获取后续接口所需的 domainId、advanceId。

Body 请求参数

默认列表（第 1 页，每页 10 条）：

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [],
  "searchHeader": {},
  "oid": "20240412279097884616",
  "params": {}
}

按域名模糊搜索：

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "domainName",
      "value": ["waf2.ruisuyun.com"]
    }
  ],
  "searchHeader": {},
  "oid": "20240412279097884616",
  "params": {}
}

按端口精确匹配：

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "port",
      "value": ["21000"]
    }
  ],
  "searchHeader": {},
  "oid": "20240412279097884616",
  "params": {}
}

Body 字段说明

字段 类型 必选 说明
oid string 是 WAF 套餐/订单 ID，与控制台 URL 中的 oid 一致；服务端会据此只返回该套餐下的域名
pageNum integer 是 页码，从 1 开始
pageSize integer 是 每页条数
filters array 否 筛选条件，见下表；不筛选时传 []
searchHeader object 否 控制台统一请求字段，本接口 不参与查询；可传 {}
params object 否 扩展参数（如日期范围封装），一般传 {}

userId 由服务端根据登录态自动填充，无需传递。

filters 筛选项

每项结构：{ "label": "<字段名>", "value": ["<值>"] }。

label 说明
domainName 域名，模糊匹配（LIKE %值%）
port 监听端口，单值时按端口匹配；多值时按 IN 查询

服务端会将 oid 自动加入筛选条件，无需在 filters 中重复传 oid。

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 鉴权 Bearer Token
body body object 是 请求体 见上文

返回示例

200 Response

{
  "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
    },
    {
      "domainId": 233,
      "advanceId": 230,
      "domainName": "lwtest.ruisuyun.com",
      "port": "0",
      "ruleCount": 0,
      "falsify": 0
    }
  ],
  "code": 200,
  "msg": "成功"
}

返回结果

状态码 状态码含义 说明
200 OK 成功
401 Unauthorized 未授权
403 Forbidden 无权限

返回数据结构

状态码 200（分页结构 TableDataInfo）

名称 类型 必选 中文名 说明
code integer 是 状态码 200 表示成功
msg string 是 提示信息 -
total integer 是 总记录数 符合 oid 与 filters 的域名总数
rows array 是 数据列表 见下表

rows[] 单条记录

字段 类型 说明
domainId integer(int64) 域名 ID；查看/维护规则、开关防篡改时使用
advanceId integer(int64) 域名高级配置 ID；与 domain_location_waf 关联，新增/编辑防篡改规则时常用
domainName string 域名（可为泛域名，如 *.testpctl.hk）
port string 监听端口；"0" 通常表示默认/未单独指定端口
ruleCount integer 已配置的 防篡改规则条数（source = falsify 的路径规则数）
falsify integer 防篡改 总开关：1 已开启，0 已关闭；与 开启关闭防篡改 的 switchState 一致

字段关系说明

  • 同一 domainName 可能对应多条记录（不同 port / domainId），例如 waf2.ruisuyun.com 在 port 为 "0" 与 "20" 时各有一条。
  • ruleCount 为 0 时，仅表示尚未配置路径级防篡改规则；falsify 仍可为 1（仅开启总开关）。
  • 进入某域名的规则列表时，请使用该行 domainId 调用 列出域名的防篡改规则。