DescribeSubDomainRecords - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves all DNS records for a specific subdomain based on the specified parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeSubDomainRecords

get

*Domain

acs:alidns::{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	en
UserClientIp	string	No	The client IP address.	192.0.2.0
SubDomain	string	Yes	For example, if you set SubDomain to a.www.example.com: If you do not specify DomainName, the system queries the DNS records for the hostname a.www of the domain name example.com. If you set DomainName to www.example.com, the system queries the DNS records for the hostname a of the domain name www.example.com. If you set DomainName to "a.www.example.com", the system queries the DNS records for the hostname @ of the domain name a.www.example.com.	a.www.example.com
PageNumber	integer	No	The page number. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
Type	string	No	The type of the DNS record. If you do not specify this parameter, all types of DNS records for the subdomain are returned. The record types are case-insensitive and include the following: A, MX, CNAME, TXT, REDIRECT_URL, FORWARD_URL, NS, AAAA, and SRV.	MX
Line	string	No	The DNS resolution line.	default
DomainName	string	No	The domain name.	example.com

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of DNS records.	2
PageSize	integer	The number of records returned on the current page.	2
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
DomainRecords	object
Record	array<object>	The list of DNS records.
	object
Status	string	The status of the DNS record.	Enable
Type	string	The record type.	CNAME
Weight	integer	The weight of the DNS record.	10
Value	string	The record value.	example.net
TTL	integer	The time to live (TTL).	600
Line	string	The DNS resolution line.	default
RecordId	string	The ID of the DNS record.	99******
Priority	integer	The priority of the 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 remarks.	test
PageNumber	integer	The page number. The value starts from 1. Default value: 1.	1

Examples

Success response

JSON format

{
  "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": "99******",
        "Priority": 2,
        "RR": "www",
        "DomainName": "example.com",
        "Locked": false,
        "Remark": "test"
      }
    ]
  },
  "PageNumber": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.