调用DescribeDomains查询CNAME接入列表_Web应用防火墙(WAF)-阿里云帮助中心

查询添加到 Web 应用防火墙的域名列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeDomains	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance ，查看当前 WAF 实例的 ID。	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
Domain	string	否	添加到 WAF 防护的域名。	www.aliyundoc.com
Backend	string	否	域名对应的源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种。	1.1.XX.XX
PageNumber	long	否	分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。	1
PageSize	long	否	分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。	10
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
Tag	object []	否	资源的标签，最多支持 20 个子项。
Key	string	否	标签键。	TagKey1
Value	string	否	标签值	TagValue1

返回参数

名称	类型	描述	示例值
	object	CNAME 接入列表。
RequestId	string	请求 ID。	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	long	查询到的域名配置的总数量。	146
Domains	object []	CNAME 接入列表。
Domain	string	已接入 WAF 的域名名称。	www.aliyundoc.com
Status	integer	域名状态。取值： 1：表示域名处于正常状态。 2：表示域名创建中。 3：表示域名修改中。 4：表示域名释放中。 5：表示域名停止转发。	1
Cname	string	WAF 为域名分配的 CNAME 地址。	xxxxxcvdaf.****.com
ListenPorts	object	配置监听信息。
Http	array	HTTP 协议的监听端口列表。
	long	HTTP 协议的监听端口。	80
Https	array	HTTPS 协议的监听端口列表。
	long	HTTPS 协议的监听端口。	443
Backeds	object	回源配置信息。
Http	object []	HTTP 协议回源地址列表。
Backend	string	HTTP 协议回源地址。	1.1.XX.XX
Https	object []	HTTPS 协议回源地址列表。
Backend	string	HTTPS 协议回源地址。	1.1.XX.XX
ResourceManagerResourceGroupId	string	阿里云资源组 ID。	rg-acfmvtc5z52****

示例

正常返回示例

JSON格式

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****"
    }
  ]
}