全部产品
Search

搜索本产品

    Web 应用防火墙：DescribeDomainAdvanceConfigs - 获取已添加的域名配置记录的详细信息

    文档中心

    Web 应用防火墙：DescribeDomainAdvanceConfigs - 获取已添加的域名配置记录的详细信息

    更新时间：Jun 27, 2024

    调用DescribeDomainAdvanceConfigs查询已添加到WAF防护的域名的详细配置。

    接口说明

    本接口用于查询已添加到 WAF 防护的域名的详细配置，例如，CNAME 地址、源站服务器地址、HTTP 和 HTTPS 端口列表等。请注意，为确保系统稳定性，对单用户 QPS 限制为 50 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

    调试

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

    授权信息

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

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

    请求参数

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

    WAF 实例的 ID。

    说明 您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
    		waf-cn-2r427ng****
    DomainListstring是

    要查询配置详情的域名。支持同时设置多个域名，多个域名间使用半角逗号（,）分隔。

    说明 您可以调用 DescribeDomainList 查询所有已接入 WAF 防护的域名。
    		www.aliyundoc.com
    ResourceGroupIdstring否

    网站域名在资源管理服务中所属的资源组 ID。

    不设置该参数表示默认资源组。

    		rg-atstuj3rtop****
    RegionIdstring否

    WAF 实例所属地域。取值：

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

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

    		cn-hangzhou

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

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    本次请求的 ID。

    		D7861F61-5B61-46CE-A47C-6B19160D5EB0
    DomainConfigsobject []

    域名的详细配置信息。

    Domainstring

    域名。

    		www.aliyundoc.com
    Profileobject

    域名配置。

    Http2Portarray

    HTTP 2.0 端口列表。

    integer

    HTTP 2.0 端口。

    		443
    Ipv6Statusinteger

    是否开启 IPv6 安全防护。取值：

    • 0：表示关闭。

    • 1：表示开启。

    		1
    HttpPortarray

    HTTP 端口列表。

    integer

    HTTP 端口。

    		80
    GSLBStatusstring

    是否启用智能负载均衡。取值：

    • off：表示否。

    • on：表示是。

    		on
    Rsarray

    源站服务器地址列表。

    string

    源站服务器地址。

    		38.XX.XX.42
    VipServiceStatusinteger

    当前使用的 WAF 实例 IP（或 WAF 虚拟集群 IP）的服务状态。取值：

    • 0：表示正常。

    • 1：表示正在进行流量清洗。

    • 2：表示处于黑洞状态。

    		0
    ClusterTypeinteger

    WAF 实例的集群类别。取值：

    • 0（默认）：表示物理集群。
    • 1：表示虚拟集群，即 WAF 独享集群。
    		0
    ExclusiveVipStatusinteger

    是否使用独享 IP。取值：

    • 0：表示否。

    • 1：表示是。

    		0
    Cnamestring

    WAF 实例为该域名配置分配的 CNAME 地址。

    		****dsbpkt75zeiok5mta2j5l7hggcrm.****.com
    CertStatusinteger

    证书状态（即 HTTPS 协议状态）。取值：

    • 0：表示异常，例如，未上传证书、上传的证书无效。

    • 1：表示正常，已上传证书且证书有效。

    		1
    HttpsPortarray

    HTTPS 端口列表。

    integer

    HTTPS 端口。

    		443
    ResolvedTypeinteger

    CNAME 解析记录类型。取值：

    • -1：表示指向源站服务器。

    • 0：表示指向 WAF 实例 IP。

    • 1：表示指向 WAF 虚拟集群 IP。

    		0

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainConfigs": [
    {
      "Domain": "www.aliyundoc.com",
      "Profile": {
        "Http2Port": [
          443
        ],
        "Ipv6Status": 1,
        "HttpPort": [
          80
        ],
        "GSLBStatus": "on",
        "Rs": [
          "38.XX.XX.42"
        ],
        "VipServiceStatus": 0,
        "ClusterType": 0,
        "ExclusiveVipStatus": 0,
        "Cname": "****dsbpkt75zeiok5mta2j5l7hggcrm.****.com",
        "CertStatus": 1,
        "HttpsPort": [
          443
        ],
        "ResolvedType": 0
      }
    }
  ]
}

    错误码

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