DescribeSubDomainRecords - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries all Domain Name System (DNS) records of a subdomain name based on the specified parameters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeSubDomainRecords	READ	Domain acs:alidns::{#accountId}:domain/{#DomainName}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
UserClientIp	string	No	The IP address of the client.	192.0.2.0
SubDomain	string	Yes	If you set SubDomain to `a.www.example.com` and leave DomainName empty, the system returns the DNS records that contain the hostname `a.www` for the domain name example.com. If you set SubDomain to a.www.example.com and set DomainName to www.example.com, the system returns the DNS records that contain the hostname `a` for the domain name www.example.com. If you set SubDomain to a.www.example.com and set DomainName to a.www.example.com, the system returns the DNS records that contain the hostname `@` for the domain name a.www.example.com.	a.www.example.com
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
Type	string	No	The type of DNS records. If you do not specify this parameter, all types of DNS records for the subdomain name are returned. Valid values: A, MX, CNAME, TXT, REDIRECT_URL, FORWORD_URL, NS, AAAA, and SRV.	MX
Line	string	No	The DNS resolution line.	default
DomainName	string	No	The domain name.	example.com

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of entries returned.	2
PageSize	long	The number of entries per page.	2
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
DomainRecords	object []	The returned DNS records.
Status	string	The status of the DNS record.	Enable
Type	string	The type of the DNS record.	CNAME
Weight	integer	The weight of the DNS record.	10
Value	string	The record value.	example.net
TTL	long	The time-to-live (TTL) of the DNS record.	600
Line	string	The DNS resolution line.	default
RecordId	string	The ID of the DNS record.	9999985
Priority	long	The priority of the mail exchanger (MX) record.	2
RR	string	The hostname.	www
DomainName	string	The domain name.	example.com
Locked	boolean	The lock status of the DNS record.	false
Remark	string	The description of the DNS record.	test
PageNumber	long	The page number. Pages start from page 1. Default value: 1.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "PageSize": 2,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "DomainRecords": {
    "Record": [
      {
        "Status": "Enable",
        "Type": "CNAME",
        "Weight": 10,
        "Value": "example.net",
        "TTL": 600,
        "Line": "default",
        "RecordId": "9999985",
        "Priority": 2,
        "RR": "www",
        "DomainName": "example.com",
        "Locked": false,
        "Remark": "test"
      }
    ]
  },
  "PageNumber": 1
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history