All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDomainInfo

Last Updated:Mar 15, 2024

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

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDomainInfoRead
  • domain
    acs:alidns::{#accountId}:domain/{#domainId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language type.

en
DomainNamestringYes

The domain name.

dns-example.com
NeedDetailAttributesbooleanNo

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

ParameterTypeDescriptionExample
object
RecordLineTreeJsonstring

The tree-structure DNS request lines.

{"default":{},"unicom":{},"telecom":{},"mobile":{},"edu":{},"oversea":{},"baidu":{},"biying":{},"google":{}}
GroupNamestring

The name of the domain name group.

mygroup
InBlackHoleboolean

Indicates whether blackhole filtering was triggered.

false
RegionLinesboolean

Indicates whether the DNS request lines are regional lines.

false
SlaveDnsboolean

Indicates whether secondary DNS is supported.

true
AliDomainboolean

Indicates whether the domain name was registered in Alibaba Cloud.

true
RequestIdstring

The request ID.

536E9CAD-DB30-4647-AC87-AA5CC38C5382
ResourceGroupIdstring

The ID of the resource group.

rg-aek3dj3wvclgcxo
InstanceIdstring

The ID of the Alibaba Cloud DNS instance.

i-7bg
DomainNamestring

The domain name.

example.com
CreateTimestring

The time when the domain name was created.

2015-12-12T09:23Z
PunyCodestring

The Punycode for the domain name. This parameter is returned only for Chinese domain names.

example.com
DnsServersarray

The DNS servers that are used to resolve the domain name.

string

The information about the DNS servers.

["vip3.alidns.com", "vip4.alidns.com"]
Remarkstring

The description.

remark
GroupIdstring

The ID of the domain name group.

2223
VersionCodestring

The version ID of Alibaba Cloud DNS.

version1
RecordLinesobject []

The DNS request lines.

FatherCodestring

The code of the parent line. This parameter is not returned if the line has no parent line.

internal
LineDisplayNamestring

The name of the parent line.

LineCodestring

The code of the line.

cn_region_xibei
LineNamestring

The name of the line.

DomainIdstring

The ID of the domain name.

00efd71a-770e-4255-b54e-6fe5659baffe
AvailableTtlsarray

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.

string

The available TTL values.

[600,1800,3600,43200,86400]
MinTtllong

The minimum TTL value.

1
InCleanboolean

Indicates whether traffic scrubbing was in progress.

false
VersionNamestring

The edition of Alibaba Cloud DNS.

LineTypestring

The type of the DNS request line.

region_province
SubDomainboolean

Indicates whether the queried domain name is a hosted subdomain name. Valid values:

  • true
  • false
false

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 timeSummary of changesOperation
2024-01-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-09-22The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.