Retrieving Subdomain Name Resolution Record Lists

Last Updated: May 27, 2016

Description

Subdomain name resolution record lists are retrieved based on input parameters.

Request Parameters

Name Type Required? Description
Action String Yes Operator interface name, required parameter, value:DescribeSubDomainRecords
SubDomain String Yes The subdomain name, e.g. www.abc.com. If you enter abc.com, this is viewed as @.abc.com
PageNumber Long No Number of the current page, starting from 1 by default
PageSize Long No When querying by page, this parameter sets the number of lines per page. Maximum value: 500, default value: 20
Type String No If this parameter is not specified, the system will return all resolution record types corresponding to the subdomain name. Resolution record types include (case insensitive): A, MX, CNAME, TXT, REDIRECT_URL, FORWORD_URL, NS, AAAA, and SRV

Return Parameters

Public return parameters. For details, see Public Return Parameters

Name Type Description
RequestId String The unique request identifier
TotalCount Long Total number of resolution records
PageNumber Long Number of the current page
PageSize Long Number of resolution records retrieved by this query
DomainRecords RecordType The resolution record list

Error Codes

For errors common to all interfaces, please refer to the Error Code Table.

Error Code Description HTTP Status Code Meaning
IncorrectDomainUser The domain name does not belong to this user. 400 The domain name does not exist under this account

Example

Request Example

http://dns.aliyuncs.com/?Action=DescribeSubDomainRecords
&SubDomain=www.abc.com
&PageNumber=1
&PageSize=20
&Type=CNAME
&<Public Request Parameters>

Return Example

XML Format

<DescribeSubDomainRecordsResponse>
    <RequestId>536E9CAD-DB30-4647-AC87-AA5CC38C5382</RequestId>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <DomainRecords>
        <Record>
            <DomainName>example.com</DomainName>
            <RecordId>9999985</RecordId>
            <RR>www</RR>
            <Type>CNAME</Type>
            <Value>mail1.hichina.com</Value>
            <Line>default</Line>
            <TTL>600</TTL>
            <Status>Enable</Status>
            <Locked>false</Locked>
            <Weight>10</Weight>
        </Record>
        <Record>
            <DomainName>example.com</DomainName>
            <RecordId>9999986</RecordId>
            <RR>www</RR>
            <Type>CNAME</Type>
            <Value>mail2.hichina.com</Value>
            <Line>default</Line>
            <TTL>600</TTL>
            <Status>Enable</Status>
            <Locked>false</Locked>
            <Weight>10</Weight>
        </Record>
    </DomainRecords>
</DescribeSubDomainRecordsResponse>

JSON Example

{
    "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 2,
    "DomainRecords": {
        "Record": [
            {
                "DomainName": "example.com",
                "RecordId": "9999985",
                "RR": "www",
                "Type": "CNAME",
                "Value": "mail1.hichina.com",
                "Line": "default",
                "TTL": 600,
                "Status": "Enable",
                "Locked": false,
                "Weight": 10
            },
            {
                "DomainName": "example.com",
                "RecordId": "9999986",
                "RR": "www",
                "Type": "CNAME",
                "Value": "mail2.hichina.com",
                "Line": "default",
                "TTL": 600,
                "Status": "Enable",
                "Locked": false,
                "Weight": 10
            }
        ]
    }
}
Thank you! We've received your feedback.