All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDomainRecordInfo

Last Updated:Oct 24, 2024

Queries the information about a Domain Name System (DNS) record.

Operation description

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.

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:DescribeDomainRecordInfoget
  • Domain
    acs:alidns::{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

en
UserClientIpstringNo

The IP address of the client.

192.0.2.0
RecordIdstringYes

The ID of the DNS record.

This parameter is returned when you add a DNS record or when you query a list of DNS records.

9999985

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The state of the DNS records. Valid values: Enable and Disable.

Enable
RRstring

The hostname.

@
GroupNamestring

The name of the domain name group.

MyGroup
RequestIdstring

The request ID.

536E9CAD-DB30-4647-AC87-AA5CC38C5382
DomainNamestring

The domain name.

dns-example.top
Prioritylong

The priority of the mail exchanger (MX) record.

5
PunyCodestring

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

xn--fsq270a.com
TTLlong

The time-to-live (TTL) of the DNS record.

600
GroupIdstring

The ID of the domain name group.

2223
Linestring

The DNS resolution line.

default
Lockedboolean

The lock state of the DNS record. Valid values: true and false.

true
Typestring

The type of the DNS record.

MX
DomainIdstring

The ID of the domain name.

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

The record value.

1.1.XX.XX
RecordIdstring

The ID of the DNS record.

9999985
Remarkstring

The description of your DNS record.

test

Examples

Sample success responses

JSONformat

{
  "Status": "Enable",
  "RR": "@",
  "GroupName": "MyGroup",
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "DomainName": "dns-example.top",
  "Priority": 5,
  "PunyCode": "xn--fsq270a.com",
  "TTL": 600,
  "GroupId": "2223",
  "Line": "default",
  "Locked": true,
  "Type": "MX",
  "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
  "Value": "1.1.XX.XX",
  "RecordId": "9999985",
  "Remark": "test"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-14The response structure of the API has changedView Change Details