全部产品
Search
文档中心

Web 应用防火墙:DescribeDomains - 查询CNAME接入列表

更新时间:Sep 13, 2024

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

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstance ,查看当前 WAF 实例的 ID。
waf_cdnsdf3****
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
Domainstring

添加到 WAF 防护的域名。

www.aliyundoc.com
Backendstring

域名对应的源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种。

1.1.XX.XX
PageNumberlong

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

1
PageSizelong

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

10
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou
Tagarray<object>

资源的标签,最多支持 20 个子项。

object

资源的标签。

Keystring

标签键。

TagKey1
Valuestring

标签值

TagValue1

返回参数

名称类型描述示例值
object

CNAME 接入列表。

RequestIdstring

请求 ID。

ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCountlong

查询到的域名配置的总数量。

146
Domainsarray<object>

CNAME 接入列表。

object

CNAME 接入详情。

Domainstring

已接入 WAF 的域名名称。

www.aliyundoc.com
Statusinteger

域名状态。取值:

  • 1:表示域名处于正常状态。

  • 2:表示域名创建中。

  • 3:表示域名修改中。

  • 4:表示域名释放中。

  • 5:表示域名停止转发。

1
Cnamestring

WAF 为域名分配的 CNAME 地址。

xxxxxcvdaf.****.com
ListenPortsobject

配置监听信息。

Httparray

HTTP 协议的监听端口列表。

long

HTTP 协议的监听端口。

80
Httpsarray

HTTPS 协议的监听端口列表。

long

HTTPS 协议的监听端口。

443
Backedsobject

回源配置信息。

Httparray<object>

HTTP 协议回源地址列表。

object

HTTP 协议回源地址。

Backendstring

HTTP 协议回源地址。

1.1.XX.XX
Httpsarray<object>

HTTPS 协议回源地址列表。

object

HTTPS 协议回源地址。

Backendstring

HTTPS 协议回源地址。

1.1.XX.XX
ResourceManagerResourceGroupIdstring

阿里云资源组 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****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情