Queries the protection settings of domain names.

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_elasticity-cn-0xldbqt****

The ID of the WAF instance.

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

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

Note This parameter is empty by default. In this case, WAF returns the protection settings of all domain names that are added to WAF.
PageNumber Integer No 1

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

PageSize Integer No 10

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

ResourceGroupId String No rg-atstuj3rtop****

The ID of the resource group to which the domain name belongs in Resource Management. This parameter is empty by default. In this case, the domain name belongs to the default resource group.

Response parameters

Parameter Type Example Description
DomainConfigs Array

The protection settings of the domain names.

AclStatus Integer 1

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

  • 0: disabled
  • 1: enabled
CcMode Integer 0

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

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

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

  • 0: disabled
  • 1: enabled
Domain String www.example.com

The domain names.

Owner String WAF

The source of the protection settings for the domain names. Valid values:

  • Anti-Bot: The protection settings were created in Anti-Bot Service.
  • WAF: The protection settings were created in WAF.
Status Integer 1

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

  • 0: invalid or deleted
  • 1: valid or created
  • 10: creating
  • 11: creation failed
  • 20: deleting
Version Long 0

The system data identifier that is used to implement optimistic locking.

WafMode Integer 0

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

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

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

  • 0: disabled
  • 1: enabled
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainBasicConfigs
&InstanceId=waf_elasticity-cn-0xldbqt****
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

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