DescribeDomainInfo - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the information about a domain name based on specified parameters.

Operation description

In this example, the domain name is bound to an instance of Alibaba Cloud DNS Enterprise Ultimate Edition. For more information about valid Domain Name System (DNS) request lines, see the return values of the RecordLines parameter.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeDomainInfo	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type.	en
DomainName	string	Yes	The domain name.	dns-example.com
NeedDetailAttributes	boolean	No	Specifies whether detailed attributes are required. The default value is false, which indicates that detailed attributes are not required. If you set this parameter to true, the values of the following parameters are returned: LineType, MinTtl, RecordLineTreeJson, RecordLines, LineCode, LineDisplayName, LineName, RegionLines, and SlaveDns.	true

Response parameters

Parameter	Type	Description	Example
	object
RecordLineTreeJson	string	The tree-structure DNS request lines.	{"default":{},"unicom":{},"telecom":{},"mobile":{},"edu":{},"oversea":{},"baidu":{},"biying":{},"google":{}}
GroupName	string	The name of the domain name group.	mygroup
InBlackHole	boolean	Indicates whether blackhole filtering was triggered.	false
RegionLines	boolean	Indicates whether the DNS request lines are regional lines.	false
SlaveDns	boolean	Indicates whether secondary DNS is supported.	true
AliDomain	boolean	Indicates whether the domain name was registered in Alibaba Cloud.	true
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
ResourceGroupId	string	The ID of the resource group.	rg-aek3dj3wvclgcxo
InstanceId	string	The ID of the Alibaba Cloud DNS instance.	i-7bg
DomainName	string	The domain name.	example.com
CreateTime	string	The time when the domain name was created.	2015-12-12T09:23Z
PunyCode	string	The Punycode for the domain name. This parameter is returned only for Chinese domain names.	example.com
DnsServers	array	The DNS servers that are used to resolve the domain name.
DnsServer	string	The information about the DNS servers.	["vip3.alidns.com", "vip4.alidns.com"]
Remark	string	The description.	remark
GroupId	string	The ID of the domain name group.	2223
VersionCode	string	The version ID of Alibaba Cloud DNS.	version1
RecordLines	array<object>	The DNS request lines.
RecordLine	object
FatherCode	string	The code of the parent line. This parameter is not returned if the line has no parent line.	internal
LineDisplayName	string	The name of the parent line.
LineCode	string	The code of the line.	cn_region_xibei
LineName	string	The name of the line.
DomainId	string	The ID of the domain name.	00efd71a-770e-4255-b54e-6fe5659baffe
AvailableTtls	array	The available time to live (TTL) values that can be configured for the domain name. Available TTL values are not returned by default. If you want to query such information, set NeedDetailAttributes to true.
AvailableTtl	string	The available TTL values.	[600,1800,3600,43200,86400]
MinTtl	long	The minimum TTL value.	1
InClean	boolean	Indicates whether traffic scrubbing was in progress.	false
VersionName	string	The edition of Alibaba Cloud DNS.
LineType	string	The type of the DNS request line.	region_province
SubDomain	boolean	Indicates whether the queried domain name is a hosted subdomain name. Valid values: true false	false
DomainLoggingSwitchStatus	string	Indicates whether the DNS traffic analysis feature is enabled. Valid values:

Examples

Sample success responses

JSONformat

{
  "RecordLineTreeJson": "{\"default\":{},\"unicom\":{},\"telecom\":{},\"mobile\":{},\"edu\":{},\"oversea\":{},\"baidu\":{},\"biying\":{},\"google\":{}}",
  "GroupName": "mygroup",
  "InBlackHole": false,
  "RegionLines": false,
  "SlaveDns": true,
  "AliDomain": true,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "ResourceGroupId": "rg-aek3dj3wvclgcxo",
  "InstanceId": "i-7bg",
  "DomainName": "example.com",
  "CreateTime": "2015-12-12T09:23Z",
  "PunyCode": "example.com",
  "DnsServers": {
    "DnsServer": [
      "[\"vip3.alidns.com\", \"vip4.alidns.com\"]"
    ]
  },
  "Remark": "remark",
  "GroupId": "2223",
  "VersionCode": "version1",
  "RecordLines": {
    "RecordLine": [
      {
        "FatherCode": "internal",
        "LineDisplayName": "",
        "LineCode": "cn_region_xibei",
        "LineName": ""
      }
    ]
  },
  "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
  "AvailableTtls": {
    "AvailableTtl": [
      "[600,1800,3600,43200,86400]"
    ]
  },
  "MinTtl": 1,
  "InClean": false,
  "VersionName": "",
  "LineType": "region_province",
  "SubDomain": false,
  "DomainLoggingSwitchStatus": ""
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-01-17	The response structure of the API has changed	View Change Details
2023-09-22	The response structure of the API has changed	View Change Details