Queries the protection settings of the domain names that are protected by Web Application Firewall (WAF).

Usage notes

You can call the DescribeDomainBasicConfigs operation to perform a paged query for the protection settings of the domain names that are protected by WAF. The settings include the status of the protection settings for each domain name, and the status and mode of each protection module. The protection modules include the protection rules engine, HTTP flood protection, and custom protection policy.

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 DescribeDomainBasicConfigs

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

InstanceId String Yes waf-cn-tl32ast****

The ID of the WAF instance.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.
DomainKey String No aliyundoc

The keyword of the domain names. WAF returns the protection settings of the domain names that contain the keyword.

If you do not specify this parameter, the protection settings of all domain names are returned.

AccessType String No waf-cloud-dns

The access mode of the domain names. WAF returns the protection settings of the domain names that are added to WAF in the specified mode. Valid values:

  • waf-cloud-dns: CNAME record mode
  • waf-cloud-native: transparent proxy mode

If you do not specify this parameter, the protection settings of all domain names are returned.

CloudNativeProductId Integer No 0

The type of the origin server. WAF returns the protection settings of the domain names that are added to WAF in transparent proxy mode and are configured with the specified type of origin server. Valid values:

  • 0: an Elastic Compute Service (ECS) instance.
  • 1: a Classic Load Balancer (CLB) instance.
  • 2: an Application Load Balancer (ALB) instance.

If you do not specify this parameter, the protection settings of all domain names are returned.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

ResourceGroupId String No rg-acfm2pz25js****

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
TotalCount Integer 1

The total number of entries returned.

RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

The ID of the request.

DomainConfigs Array of DomainConfig

The protection settings of the domain name.

Status Integer 1

The status of the protection settings for the domain name. Valid values:

  • 0: invalid or deleted
  • 1: valid or created
  • 10: creating
  • 11: creation failed
  • 20: deleting
Domain String www.aliyundoc.com

The domain name.

Owner String WAF

The source of the protection settings for the domain name. The value is fixed as WAF, which indicates that the protection settings are created in WAF.

CcMode Integer 0

The mode of the HTTP flood protection module. Valid values:

  • 0: the protection mode
  • 1: the protection-emergency mode
CcStatus Integer 1

The status of the HTTP flood protection module. Valid values:

  • 0: disabled
  • 1: enabled
AccessType String waf-cloud-dns

The access mode of the domain name. Valid values:

  • waf-cloud-dns: CNAME record mode
  • waf-cloud-native: transparent proxy mode
Version Long 0

The version of the protection settings.

AclStatus Integer 1

The status of the custom protection policy module. Valid values:

  • 0: disabled
  • 1: enabled
WafStatus Integer 1

The status of the protection rules engine module. Valid values:

  • 0: disabled
  • 1: enabled
WafMode Integer 0

The mode of the protection rules engine module. Valid values:

  • 0: the block mode
  • 1: the warn mode

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainBasicConfigs
&InstanceId=waf-cn-tl32ast****
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format 

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

<DescribeDomainBasicConfigsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <DomainConfigs>
        <Status>1</Status>
        <Domain>www.aliyundoc.com</Domain>
        <Owner>WAF</Owner>
        <CcMode>0</CcMode>
        <CcStatus>1</CcStatus>
        <Version>0</Version>
        <AclStatus>1</AclStatus>
        <WafStatus>1</WafStatus>
        <WafMode>0</WafMode>
    </DomainConfigs>
</DescribeDomainBasicConfigsResponse>

JSON format 

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

{
  "TotalCount" : 1,
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainConfigs" : [ {
    "Status" : 1,
    "Domain" : "www.aliyundoc.com",
    "Owner" : "WAF",
    "CcMode" : 0,
    "CcStatus" : 1,
    "Version" : 0,
    "AclStatus" : 1,
    "WafStatus" : 1,
    "WafMode" : 0
  } ]
}

Error codes

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