Queries information about 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 DescribeDomainList

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

SourceIp String No 1.2.XX.XX

The source IP address of the request.

FuzzyDomain String No sas

The keyword that is used to query domain names. Fuzzy match is supported.

DomainType String No root

The type of the domain name that you want to query. Valid values:

  • root: root domain name
  • sub: subdomain name
PageSize Integer No 10

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

CurrentPage Integer No 1

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

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 0B48AB3C-84FC-424D-A01D-B9270EF46038

The ID of the request, which is used to locate and troubleshoot issues.

PageInfo Object

The pagination information.

CurrentPage Integer 10

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page. Default value: 10.

TotalCount Integer 27

The total number of entries returned.

Count Integer 10

The total number of entries returned on the current page.

DomainListResponseList Array of DomainResponse

The information about domain names.

IpList String 1.2.XX.XX,1.0.XX.XX

The IP addresses of the domain name.

Domain String example.com

The name of the domain or website.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainList
&SourceIp=1.2.XX.XX
&FuzzyDomain=sas
&DomainType=root
&PageSize=10
&CurrentPage=1
&Common request parameters

Sample success responses

XML format

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

<DescribeDomainListResponse>
    <RequestId>0B48AB3C-84FC-424D-A01D-B9270EF46038</RequestId>
    <PageInfo>
        <CurrentPage>10</CurrentPage>
        <PageSize>10</PageSize>
        <TotalCount>27</TotalCount>
        <Count>10</Count>
    </PageInfo>
    <DomainListResponseList>
        <IpList>1.2.XX.XX,1.0.XX.XX</IpList>
        <Domain>example.com</Domain>
    </DomainListResponseList>
</DescribeDomainListResponse>

JSON format

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

{
  "RequestId" : "0B48AB3C-84FC-424D-A01D-B9270EF46038",
  "PageInfo" : {
    "CurrentPage" : 10,
    "PageSize" : 10,
    "TotalCount" : 27,
    "Count" : 10
  },
  "DomainListResponseList" : [ {
    "IpList" : "1.2.XX.XX,1.0.XX.XX",
    "Domain" : "example.com"
  } ]
}

Error codes

HTTP status code Error code Error message Description
500 ServerError ServerError The error message returned because a server error occurred.

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