Queries the details about the configurations of the domain names that are protected by Web Application Firewall (WAF).

Description

You can call the DescribeDomainAdvanceConfigs operation to query the details about the configurations of the domain names that are protected by WAF. The details include the CNAMEs, origin server addresses, and HTTP and HTTPS ports.

Limits

You can call this operation up to 50 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDomainAdvanceConfigs

The operation that you want to perform. Set the value to DescribeDomainAdvanceConfigs.

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

The ID of the WAF instance.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.
DomainList String Yes www.aliyundoc.com

The domain name for which you want to query the details about the configurations. If you enter multiple domain names, separate the domain names with commas (,).

Note You can call the DescribeDomainList operation to query all domain names that are protected by WAF.
ResourceGroupId String No rg-atstuj3rtop****

The ID of the resource group to which the domain name belongs in Resource Management.

If you do not specify this parameter, the domain name belongs to the default resource group.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

The ID of the request.

DomainConfigs Array of DomainConfig

The details about the configurations of the domain name.

Domain String www.aliyundoc.com

The domain name.

Profile Object

The configurations of the domain name.

Http2Port Array of Integer 443

The HTTP/2 port.

Ipv6Status Integer 1

Indicates whether protection against malicious IPv6 traffic is enabled. Valid values:

  • 0: The protection is disabled.
  • 1: The protection is enabled.
HttpPort Array of Integer 80

The HTTP port.

GSLBStatus String on

Indicates whether intelligent load balancing is enabled. Valid values:

  • off
  • on
Rs Array of String 38.XX.XX.42

The address of the origin server.

VipServiceStatus Integer 0

The service status of the IP address of the WAF instance or the exclusive WAF cluster. Valid values:

  • 0: The traffic to the IP address is normal.
  • 1: The traffic to the IP address is being scrubbed.
  • 2: The traffic to the IP address is undergoing blackhole filtering.
ClusterType Integer 0

The type of the WAF cluster. Valid values:

  • 0: shared cluster. This is the default value.
  • 1: exclusive cluster.
ExclusiveVipStatus Integer 0

Indicates whether an exclusive WAF IP address is used. Valid values:

  • 0: no
  • 1: yes
Cname String ****dsbpkt75zeiok5mta2j5l7hggcrm.****.com

The CNAME that the WAF instance assigns for the domain name.

CertStatus Integer 1

Indicates the status of the certificate that is configured for the domain name. This parameter is returned only when the domain name supports HTTPS. Valid values:

  • 0: abnormal. For example, no certificate is uploaded, or the uploaded certificate is invalid.
  • 1: normal. For example, a certificate is uploaded, and the certificate is valid.
HttpsPort Array of Integer 443

The HTTPS port.

ResolvedType Integer 0

The IP address to which the CNAME is resolved. Valid values:

  • -1: the IP address of the origin server.
  • 0: the IP address of the WAF instance.
  • 1: the IP address of the exclusive WAF cluster.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainAdvanceConfigs
&InstanceId=waf-cn-2r427ng****
&DomainList=www.aliyundoc.com
&Common request parameters

Sample success responses

XML format 

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 format 

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
    }
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.