All Products
Search
Document Center

Alibaba Cloud DNS:RetrieveDomain

Last Updated:Dec 02, 2025

Retrieves a domain name.

Operation description

Before you can retrieve a domain name, you must verify it using a TXT record. Use this operation in conjunction with the Generate a TXT record operation.

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

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

The language of the return value. Valid values:

  • zh: Chinese

  • en: English

Default value: zh.

en

DomainName

string

Yes

The domain name. Call DescribeDomains to obtain the domain name.

example.com

Response elements

Element

Type

Description

Example

object

RequestId

string

The unique ID of the request.

9CC0D642-49D4-48DE-A1A5-9F218652E4A7

Examples

Success response

JSON format

{
  "RequestId": "9CC0D642-49D4-48DE-A1A5-9F218652E4A7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.