Queries the domain names that are added to Web Application Firewall (WAF) by page.

Note You can also call the DescribeDomainNames operation to query the domain names that are added to WAF. However, this operation does not support the paged query, and all domain names are returned on one page. If you want to query a large number of domain names, we recommend that you call the DescribeDomainList operation. This operation allows you to specify different conditions for the query and returns query results by page.

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 DescribeDomainList

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

InstanceId String Yes waf-cn-7pp26f1****

The ID of the WAF instance.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.
ResourceGroupId String No rg-acfm2pz25js****

The ID of the resource group to which the WAF instance belongs in Resource Management. This parameter is empty by default, which indicates that the WAF instance belongs to the default resource group.

For more information about resource groups, see Create a resource group.

DomainName String No example.com

The domain name to query.

You can specify this parameter to check whether a domain name is added to WAF. Fuzzy match is supported.

DomainNames.N RepeatList No example.com

Domain name N to query.

You can specify this parameter to check whether multiple domain names are added to WAF. Fuzzy match is supported.

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.

IsSub Integer No 0

The type of domain name to query. Valid values:

  • 0: all domain names, including both exact match domain names and wildcard domain names. This is the default value.
  • 1: exact match domain names.

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
DomainNames List ["www.example.com","test.example.com"]

The domain names that are returned.

RequestId String 592E866F-6C05-4E7C-81DE-B4D8E86B91EF

The ID of the request.

TotalCount Integer 2

The number of domain names that are returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainList
&InstanceId=waf-cn-7pp26f1****
&<Common request parameters>

Sample success responses

XML format 

<DescribeDomainListResponse>
	  <TotalCount>2</TotalCount>
	  <RequestId>592E866F-6C05-4E7C-81DE-B4D8E86B91EF</RequestId>
	  <DomainNames>www.example.com</DomainNames>
	  <DomainNames>test.example.com</DomainNames>
</DescribeDomainListResponse>

JSON format 

{
  "TotalCount": 2,
  "RequestId": "592E866F-6C05-4E7C-81DE-B4D8E86B91EF",
  "DomainNames": [
    "www.example.com",
    "test.example.com"
  ]
}

Error codes

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