调用DescribeDomainList分页查询已添加到WAF防护的域名列表。

说明 DescribeDomainNames接口也可以用于查询已添加到WAF防护的所有域名,但是不支持分页查询(即只能一次性返回所有域名)。对于域名数量较多的场景,推荐您调用该接口进行分页查询(分页显示结果并支持按条件查询)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDomainList

要执行的操作。取值:DescribeDomainList

InstanceId String waf-cn-7pp26f1****

WAF实例的ID。

说明 您可以调用 DescribeInstanceInfo,查看当前WAF实例的ID。
ResourceGroupId String rg-acfm2pz25js****

WAF实例在资源管理服务中所属的资源组ID。默认为空,即属于默认资源组。

关于资源组的更多信息,请参见创建资源组

DomainName String example.com

要查询的域名名称。

您可以设置该参数,模糊查询某个域名是否已接入WAF防护。

DomainNames.N RepeatList example.com

要查询的域名列表。

您可以设置该参数,模糊查询多个域名是否已接入WAF防护。

PageNumber Integer 1

分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。

PageSize Integer 10

分页查询时,每页包含多少条结果。默认值为10,表示每页包含10条结果。

IsSub Integer 0

要查询的域名类型。取值:

  • 0(默认):表示查询所有域名(包含具体域名和泛域名)。
  • 1:表示仅查询具体域名。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
DomainNames List ["www.example.com","test.example.com"]

查询到的域名列表。

RequestId String 592E866F-6C05-4E7C-81DE-B4D8E86B91EF

本次请求的ID。

TotalCount Integer 2

查询到的域名的数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDomainList
&InstanceId=waf-cn-7pp26f1****
&<公共请求参数>

正常返回示例

XML格式

<DescribeDomainListResponse>
	  <TotalCount>2</TotalCount>
	  <RequestId>592E866F-6C05-4E7C-81DE-B4D8E86B91EF</RequestId>
	  <DomainNames>www.example.com</DomainNames>
	  <DomainNames>test.example.com</DomainNames>
</DescribeDomainListResponse>

JSON格式

{
  "TotalCount": 2,
  "RequestId": "592E866F-6C05-4E7C-81DE-B4D8E86B91EF",
  "DomainNames": [
    "www.example.com",
    "test.example.com"
  ]
}

错误码

访问错误中心查看更多错误码。