All Products
Search
Document Center

Direct Mail:DescDomain

Last Updated:Jul 08, 2024

Configures a domain name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

DomainId

Integer

Yes

13464

The ID of the domain name.

Action

String

No

DescDomain

The operation that you want to perform. Set the value to DescDomain.

RequireRealTimeDnsRecords

boolean

No

true

Determine whether to perform real-time DNS parsing

Response parameters

Parameter

Type

Example

Description

SpfRecord

String

include:spf1.dm.aliyun.com

Spf records provided by the Direct Mail console.

CnameConfirmStatus

String

0

Whether the host record of CNAME has been changed. Changed: 1 (changing back to the original value is also a change). Unchanged: 0.

DefaultDomain

String

0

Is it the default domain name?

Value: 0 No (this field is deprecated)

CreateTime

String

2019-09-29T12:49Z

The time when the DNS record was created.

CnameRecord

String

dmtrace

Customized part of CNAME host record.

CnameAuthStatus

String

1

Indicates whether the CNAME record is successfully verified.

Valid values: 0 and 1.

  • 0:indicates the verification is successful.

  • 1: indicates that the verification fails.

IcpStatus

String

1

The status of ICP filing. Valid values: 0 and 1.1: indicates that the domain name is filed.0: indicates that the domain name is not filed.

DnsTxt

String

121309ohdsa

TXT record value resolved through public DNS.

DomainName

String

test.example.net

The domain name.

DomainId

String

158910

The ID of the domain name.

DnsSpf

String

v=xxxx

SPF record value resolved through public DNS

SpfAuthStatus

String

1

Indicates whether the SPF record is successfully verified. Valid values: 0 and 1. 0: indicates the verification is successful. 1: indicates that the verification fails.

RequestId

String

51B74264-46B4-43C8-A9A0-6B8E8BC04F34

The ID of the request.

MxRecord

String

mx01.dm.aliyun.com

MX records provided by the Direct Mail console.

MxAuthStatus

String

1

Indicates whether the MX record is successfully verified. Valid values: 0 and 1. 0: indicates the verification is successful. 1: indicates that the verification fails.

DnsMx

String

mx01.dm.aliyun.com

MX record value resolved through public DNS

DomainStatus

String

1

The status of the domain name. Indicates whether the domain name is verified and available. Valid values:

  • 0: indicates that the domain name is verified and available.

  • 1: indicates that the domain name fails to be verified and is unavailable.

  • 2: indicates that the domain name is available, but not filed or configured with a CNAME record.

  • 3: indicates that the domain name is available but not filed.

  • 4: indicates that the domain name is available but not configured with a CNAME record.

TlDomainName

String

example.net

The primary domain name.

TracefRecord

String

tracedm.aliyuncs.com

The CNAME verification record provided by the Direct Mail console.

DomainType

String

0c40d5f125af4e42892a

TXT records provided by the Direct Mail console.

SpfRecordV2

String

v=spf1 include:spfdm-ap-southeast-1.aliyun.com -all

SpfRecord

DkimRR

String

aliyun-ap-southeast-1._domainkey.xxx

DKIM HostRecord

DkimPublicKey

String

v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb...

DKIM public key

DkimAuthStatus

String

1

DKIM validation flag, success: 0, failure: 1.

HostRecord

String

xxx

host record

DmarcHostRecord

String

_dmarc.xxx

DMARC host record

DmarcRecord

String

v=DMARC1;p=none;rua=mailto:dmarc_report@service.aliyun.com

DMARC record

DnsDmarc

String

v=DMARC1;p=none;rua=mailto:dmarc_report@service.aliyun.com

DMARC record value resolved through public DNS

DmarcAuthStatus

Integer

1

DMARC validation flag, success: 0, failure: 1.

Samples

Sample requests

http(s)://dm.aliyuncs.com/? Action=DescDomain
&DomainId=401591
&<Common request parameters>

Sample success responses

JSON format

{
  "HostRecord": "dmailtest",
  "CnameAuthStatus": 1,
  "CnameRecord": "dmtrace",
  "IcpStatus": 1,
  "DefaultDomain": 0,
  "DomainType": "df29ab561bb140e98dfb",
  "SpfRecordV2": "v=spf1 include:spf1.dm.aliyun.com -all",
  "DkimRR": "aliyun-cn-hangzhou._domainkey.dmailtest",
  "TlDomainName": "sdysy.top",
  "SpfRecord": "include:spf1.dm.aliyun.com",
  "SpfAuthStatus": 0,
  "RequestId": "9C7FB8ED-BF86-5BA1-B0EF-BB71937C2036",
  "DomainName": "dmailtest.sdysy.top",
  "DnsMx": "mx01.dm.aliyun.com",
  "CreateTime": "2023-09-11T17:59Z",
  "DnsTxt": "df29ab561bb140e98dfb",
  "CnameConfirmStatus": 0,
  "DnsSpf": "v=spf1 include:spf1.dm.aliyun.com -all",
  "MxRecord": "mx01.dm.aliyun.com",
  "DomainId": 401591,
  "MxAuthStatus": 0,
  "TracefRecord": "tracedm.aliyuncs.com",
  "DkimPublicKey": "v=DKIM1; k=rsa; p=xxx",
  "DkimAuthStatus": 0,
  "DmarcAuthStatus": 1,
  "DomainStatus": 3,
  "DmarcHostRecord": "_dmarc.xxx",,
  "DmarcRecord": "v=DMARC1;p=none;rua=mailto:dmarc_report@service.aliyun.com",
  "DnsDmarc": "v=DMARC1;p=none;rua=mailto:dmarc_report@service.aliyun.com"
}

Error codes

HTTP status code

Error code

Error message

Description

400

InvalidDomainId.Malformed

The specified domain ID does not exist.

Domain name ID does not exist.

For a list of error codes, visit the API Error Center.