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

使用说明

本接口用于查询已添加到WAF防护的域名的详细配置,例如,CNAME地址、源站服务器地址、HTTP和HTTPS端口列表等。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

请求参数

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

要执行的操作。取值:DescribeDomainAdvanceConfigs

InstanceId String waf-cn-2r427ng****

WAF实例的ID。

说明 您可以调用DescribeInstanceInfo查询当前WAF实例的ID。
DomainList String www.aliyundoc.com

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

说明 您可以调用DescribeDomainList查询所有已接入WAF防护的域名。
ResourceGroupId String rg-atstuj3rtop****

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

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

本次请求的ID。

DomainConfigs Array of DomainConfig

域名的详细配置信息。

Domain String www.aliyundoc.com

域名。

Profile Object

域名配置。

Http2Port Array of Integer 443

HTTP 2.0端口。

Ipv6Status Integer 1

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

  • 0:表示关闭。
  • 1:表示开启。
HttpPort Array of Integer 80

HTTP端口。

GSLBStatus String on

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

  • off:表示否。
  • on:表示是。
Rs Array of String 38.XX.XX.42

源站服务器地址。

VipServiceStatus Integer 0

当前使用的WAF实例IP(或WAF虚拟集群IP)的服务状态。取值:

  • 0:表示正常。
  • 1:表示正在进行流量清洗。
  • 2:表示处于黑洞状态。
ClusterType Integer 0

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

  • 0(默认):表示物理集群。
  • 1:表示虚拟集群,即WAF独享集群。
ExclusiveVipStatus Integer 0

是否使用独享IP。取值:

  • 0:表示否。
  • 1:表示是。
Cname String ****dsbpkt75zeiok5mta2j5l7hggcrm.****.com

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

CertStatus Integer 1

证书状态(即HTTPS协议状态)。取值:

  • 0:表示异常,例如,未上传证书、上传的证书无效。
  • 1:表示正常,已上传证书且证书有效。
HttpsPort Array of Integer 443

HTTPS端口。

ResolvedType Integer 0

CNAME解析记录类型。取值:

  • -1:表示指向源站服务器。
  • 0:表示指向WAF实例IP。
  • 1:表示指向WAF虚拟集群IP。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDomainAdvanceConfigs
&InstanceId=waf-cn-2r427ng****
&DomainList=www.aliyundoc.com
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainAdvanceConfigsResponse>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <DomainConfigs>
        <Domain>www.aliyundoc.com</Domain>
        <Profile>
            <Http2Port>443</Http2Port>
            <Ipv6Status>1</Ipv6Status>
            <HttpPort>80</HttpPort>
            <GSLBStatus>on</GSLBStatus>
            <Rs>38.XX.XX.42</Rs>
            <VipServiceStatus>0</VipServiceStatus>
            <ClusterType>0</ClusterType>
            <ExclusiveVipStatus>0</ExclusiveVipStatus>
            <Cname>****dsbpkt75zeiok5mta2j5l7hggcrm.****.com</Cname>
            <CertStatus>1</CertStatus>
            <HttpsPort>443</HttpsPort>
            <ResolvedType>0</ResolvedType>
        </Profile>
    </DomainConfigs>
</DescribeDomainAdvanceConfigsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    }
  } ]
}

错误码

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