DescribeDomainList - 查询域名资产信息

更新时间: 2024-07-24 17:07:43

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

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

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

rg-acfm2pz25js****
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstanceInfo ,查看当前 WAF 实例的 ID。
waf-cn-7pp26f1****
DomainNamestring

要查询的域名名称。

您可以设置该参数,前缀匹配某个域名是否已接入 WAF 防护。

example.com
PageNumberinteger

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

1
PageSizeinteger

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

10
IsSubinteger

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

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

要查询的域名列表。

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

string

要查询的域名。

example.com
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

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

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

返回参数

名称类型描述示例值
object
TotalCountinteger

查询到的域名的数量。

2
RequestIdstring

本次请求的 ID。

592E866F-6C05-4E7C-81DE-B4D8E86B91EF
DomainNamesarray

查询到的域名列表。

string

域名。

www.example.com

示例

正常返回示例

JSON格式

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

错误码

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

上一篇: DescribeDomainAdvanceConfigs - 获取已添加的域名配置记录的详细信息 下一篇: 防护配置
阿里云首页 Web应用防火墙 相关技术圈