调用DescribeDomainList分页查询已添加到WAF防护的域名列表。
接口说明
说明
DescribeDomainNames 接口也可以用于查询已添加到 WAF 防护的所有域名，但是不支持分页查询（即只能一次性返回所有域名）。对于域名数量较多的场景，推荐您调用该接口进行分页查询（分页显示结果并支持按条件查询）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-waf:DescribeDomainList | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ResourceGroupId | string | 否 | WAF 实例在资源管理服务中所属的资源组 ID。默认为空，即属于默认资源组。 关于资源组的更多信息，请参见创建资源组。 | rg-acfm2pz25js**** |
| InstanceId | string | 是 | WAF 实例的 ID。 说明
您可以调用 DescribeInstanceInfo ，查看当前 WAF 实例的 ID。
| waf-cn-7pp26f1**** |
| DomainName | string | 否 | 要查询的域名名称。 您可以设置该参数，模糊查询某个域名是否已接入 WAF 防护。 | example.com |
| PageNumber | integer | 否 | 分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。 | 1 |
| PageSize | integer | 否 | 分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。 | 10 |
| IsSub | integer | 否 | 要查询的域名类型。取值：
| 0 |
| DomainNames | array | 否 | 要查询的域名列表。 您可以设置该参数，模糊查询多个域名是否已接入 WAF 防护。 | |
| string | 否 | 要查询的域名。 | example.com | |
| RegionId | string | 否 | WAF 实例所属地域。取值：
| cn-hangzhou |
调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。
调用 API 的请求格式，请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 2,
"RequestId": "592E866F-6C05-4E7C-81DE-B4D8E86B91EF",
"DomainNames": [
"www.example.com"
]
}错误码
访问错误中心查看更多错误码。