DescribeDomainNs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Operation description

Note

This operation directly queries the authoritative server of the domain name registry to retrieve the DNS server names for the domain name. An error may be returned if the domain name is inactive. For example, if the domain name has a serverHold or clientHold status, or has not passed identity verification.

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:DescribeDomainNs

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. Valid values: zh: Chinese en: English Default value: zh.	en
DomainName	string	Yes	The domain name. You can call the DescribeDomains operation to obtain this value.	example.com

Response elements

Element	Type	Description	Example
	object
AllAliDns	boolean	Indicates whether all name servers are Alibaba Cloud DNS servers.	true
RequestId	string	The unique request ID.	16C7DC7A-2FA7-4D14-8B12-88A2BB6373DB
ExpectDnsServers	object
ExpectDnsServer	array	The name servers assigned to the domain name by Alibaba Cloud DNS.
	string	The name server assigned to the domain name by Alibaba Cloud DNS.	x1.alidns.com,x2.alidns.com
DnsServers	object
DnsServer	array	The name servers that are currently configured for the domain name.
	string	The name server that is currently configured for the domain name.	vip1.alidns.com,vip2.alidns.com
IncludeAliDns	boolean	Indicates whether the list of name servers includes Alibaba Cloud DNS servers.	true
DetectFailedReasonCode	string	The error code returned if the detection fails.	DnsCheck.Failed

Examples

Success response

JSON format

{
  "AllAliDns": true,
  "RequestId": "16C7DC7A-2FA7-4D14-8B12-88A2BB6373DB",
  "ExpectDnsServers": {
    "ExpectDnsServer": [
      "x1.alidns.com,x2.alidns.com"
    ]
  },
  "DnsServers": {
    "DnsServer": [
      "vip1.alidns.com,vip2.alidns.com"
    ]
  },
  "IncludeAliDns": true,
  "DetectFailedReasonCode": "DnsCheck.Failed"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.