API for retrieving custom domain names and parsing counts - HTTPDNS

Call the ListDomains operation to query the domain names and their resolution counts in your account based on specified parameters.

API reference

You can specify the page number (PageNumber) and the number of entries per page (PageSize) to paginate the results.
By default, domain names are sorted in descending order by the time they were added.

Debugging

You can call this operation directly in OpenAPI Explorer. This eliminates the need to calculate signatures. After a successful call, OpenAPI Explorer automatically generates sample code for different SDKs.

Request parameters

Name	Type	Required	Example	Description
Action	String	Yes	ListDomains	The action to perform. Set the value to ListDomains.
PageNumber	Integer	No	1	The page number. Pages start from 1. Default value: 1.
PageSize	Integer	No	20	The number of entries to return on each page. Maximum value: 100. Default value: 20.

Returned data

Name	Type	Example	Description
PageSize	Long	5	The number of domain names returned on the current page.
RequestId	String	50F9C40E-188D-4208-BE2C-7427E531****	The ID of the request.
PageNumber	Long	1	Total number of domain names.
TotalCount	Long	18	The total number of domain names.
DomainInfos	Array of DomainInfo		The list of domain names.
DomainInfo
ResolvedHttps6	Long	20	The number of HTTPS-based resolutions to IPv6 addresses.
Resolved	Long	10	The number of HTTP-based resolutions to IPv4 addresses.
Resolved6	Long	20	The number of HTTP-based resolutions to IPv6 addresses.
DomainName	String	www.example.com	The domain name.
ResolvedHttps	Long	10	The number of HTTPS-based resolutions to IPv4 addresses.

Examples

Sample request

http(s)://httpdns-api.aliyuncs.com/?Action=ListDomains
&<Common request parameters>

Sample response

XML format

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

<?xml version='1.0' encoding='UTF-8'?>
<ListDomainsResponse>
    <RequestId>50F9C40E-188D-4208-BE2C-7427E5316481</RequestId>
    <TotalCount>18</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>5</PageSize>
    <DomainInfos>
        <DomainInfo>
            <DomainName>www.aliyun.com</DomainName>
            <Resolved>10</Resolved>
            <ResolvedHttps>20</ResolvedHttps>
        </DomainInfo>
        <DomainInfo>
            <DomainName>bbs.aliyun.com</DomainName>
            <Resolved>10</Resolved>
            <ResolvedHttps>20</ResolvedHttps>
        </DomainInfo>
        <DomainInfo>
            <DomainName>www.taobao.com</DomainName>
            <Resolved>10</Resolved>
            <ResolvedHttps>20</ResolvedHttps>
        </DomainInfo>
        <DomainInfo>
            <DomainName>www.tmall.com</DomainName>
            <Resolved>10</Resolved>
            <ResolvedHttps>20</ResolvedHttps>
        </DomainInfo>
        <DomainInfo>
            <DomainName>alipay.com</DomainName>
            <Resolved>10</Resolved>
            <ResolvedHttps>20</ResolvedHttps>
        </DomainInfo>
    </DomainInfos>
</ListDomainsResponse>

JSON format

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

{
  "RequestId" : "50F9C40E-188D-4208-BE2C-7427E5316481",
  "TotalCount" : 18,
  "PageNumber" : 1,
  "PageSize" : 5,
  "DomainInfos" : [ {
    "DomainName" : "www.aliyun.com",
    "Resolved" : 10,
    "ResolvedHttps" : 20
  }, {
    "DomainName" : "bbs.aliyun.com",
    "Resolved" : 10,
    "ResolvedHttps" : 20
  }, {
    "DomainName" : "www.taobao.com",
    "Resolved" : 10,
    "ResolvedHttps" : 20
  }, {
    "DomainName" : "www.tmall.com",
    "Resolved" : 10,
    "ResolvedHttps" : 20
  }, {
    "DomainName" : "alipay.com",
    "Resolved" : 10,
    "ResolvedHttps" : 20
  } ]
}

Error codes

For a list of error codes, see the Error Center.