WAF3.0 API¶

POST 查询域名列表¶

POST /prod-api/waf/wafv3/domains/describeDomainList

分页查询指定 WAF 套餐（oid）下已接入的域名资源列表，用于 WAF 控制台「资源」页：查看域名基础信息、CNAME、证书与策略组关联状态，并获取批量关联策略时所需的 id（域名 ID）。

关联/移除策略组：修改域名与 WAF 关联关系（传 domainIds、wafId）

Body 请求参数

默认列表：

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

}

按域名筛选（模糊匹配）：

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "domainName",
      "value": ["*.testpctl.hk"]
    }
  ],
  "searchHeader": {},
  "oid": "20240412279097884616"

}

Body 字段说明¶

字段	类型	必选	说明
`oid`	string	是	WAF 套餐/订单 ID，与控制台 URL 中的 `oid` 一致；为空时接口报错「套餐ID不能为空」
`pageNum`	integer	是	页码，从 `1` 开始
`pageSize`	integer	是	每页条数
`filters`	array	否	筛选条件，见下表；不筛选时传 `[]`
`searchHeader`	object	否	表头/状态筛选，见下表；无筛选时传 `{}`

`filters` 筛选项¶

每项结构：{ "label": "<字段名>", "value": ["<值>"] }。单值时多为模糊匹配（LIKE %值%）。

`label`	说明
`domainName`	域名（支持泛域名，如 `*.testpctl.hk`）
`port`	监听端口
`doid`	套餐/订单 ID
`ip`	回源 IP
`customerRemark`	备注

`searchHeader`（表头筛选）¶

字段	类型	说明
`isActive`	string	域名状态筛选，取值与返回字段 `isActive` 一致，见下表

isActive 取值：

取值	含义
`"0"`	配置中
`"1"`	活跃/部署中
`"2"`	暂停

按「活跃/部署中」筛选示例：

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

请求参数¶

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

返回示例

200 Response

{
  "total": 1,
  "rows": [
    {
      "id": 657,
      "sslsupport": "0",
      "domainName": "*.testpctl.hk",
      "ip": "1.1.1.1",
      "port": "0",
      "cNamePre": "alldomainurl.testpctl.hk",
      "cNameSuf": ".ruisuyun.cn",
      "doid": "20240412279097884616",
      "isActive": "1",
      "customerRemark": "",
      "alias": "c8f24509cb564acfbad2fbfa2eac4d",
      "coreId": null,
      "waf": null,
      "stopTime": "0",
      "updateTime": "1778730016",
      "certEndTime": null,
      "originProtocol": null,
      "certStatus": null,
      "certSource": null,
      "isIntermediateSource": null,
      "origin": null,
      "wafAclName": null,
      "wafAclId": null,
      "wafAclStatus": null
    }
  ],
  "code": 200,
  "msg": "成功"
}

返回结果¶

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

返回数据结构¶

状态码 200（分页结构 TableDataInfo）

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

`rows[]` 常用字段¶

字段	类型	说明
`id`	integer(int64)	域名 ID；关联策略、跳转域名详情等使用（其它文档中也可能写作 `domainId`）
`domainName`	string	域名
`port`	string	监听端口；`"0"` 通常表示默认端口
`ip`	string	回源地址，多行时以换行分隔
`sslsupport`	string	是否 HTTPS：`"0"` 否，`"1"` 是
`cNamePre`	string	CNAME 前缀
`cNameSuf`	string	CNAME 后缀；完整 CNAME 一般为 `cNamePre` + `cNameSuf`
`doid`	string	所属套餐/订单 ID，与请求 `oid` 一致
`isActive`	string	域名状态：`"0"` 配置中，`"1"` 活跃/部署中，`"2"` 暂停
`customerRemark`	string	备注
`alias`	string	订单别名标识
`updateTime`	string	最近更新时间（Unix 时间戳，秒）
`stopTime`	string	停用相关时间戳
`wafAclId`	integer / null	已关联的 WAF 策略组 ID；`null` 表示未关联
`wafAclName`	string / null	已关联的策略组名称
`wafAclStatus`	string / null	策略组状态（与控制台策略组状态字典一致）
`waf`	string / null	WAF 核心接入标记
`coreId`	string / null	WAF 核心记录 ID
`certEndTime`	string / null	证书到期时间（HTTPS 且已配置证书时可能有值）
`certStatus`	string / null	证书状态
`certSource`	string / null	证书来源
`originProtocol`	integer / null	回源协议
`isIntermediateSource`	string / null	中间源开关
`origin`	object / null	回源配置详情（结构以实现为准）