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.

AccessKeyId String No xxx

The AccessKey ID provided to you by Alibaba Cloud.

Action String No DescDomain

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

Response parameters

Parameter Type Example Description
CnameAuthStatus String 1

Indicates whether your ownership of the domain is verified.

CnameConfirmStatus String 0

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.

CnameRecord String dmtrace

The value of the CNAME record.

CreateTime String 2019-09-29T12:49Z

The time when the DNS record was created.

DefaultDomain String 0

The default domain name.

DnsMx String abc-com.xxxx.com

The value of the MX record.

DnsSpf String v=xxxx

The value of the SPF record.

DnsTxt String 121309ohdsa

The value of the TXT ownership record.

DomainId String 158910

The ID of the domain name.

DomainName String abc.com

The domain name.

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.
DomainType String 0c40d5f125af4e42892a

The type of the domain.

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.

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.

MxRecord String mx01.dm.aliyun.com

The MX verification record provided by Alibaba Cloud DNS.

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

The ID of the request.

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.

SpfRecord String  include:spf1.dm.aliyun.com

The SPF verification record provided by Alibaba Cloud DNS.

TlDomainName String  abc.com

The primary domain name.

TracefRecord String  tracedm.aliyuncs.com

The CNAME verification record provided by Alibaba Cloud DNS.

Samples

Sample requests


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

Sample success responses

JSON format

{
	"MxAuthStatus":1,
	"DnsMx":"abc-com.mail.protection.outlook.com",
	"IcpStatus":1,
	"TracefRecord":"tracedm.aliyuncs.com",
	"DnsSpf":"v=spf1 include:spf.disney.com -all",
	"DomainStatus":1,
	"DefaultDomain":0,
	"CnameConfirmStatus":1,
	"TlDomainName":"abc.com",
	"MxRecord":"mx01.dm.aliyun.com",
	"SpfRecord":"include:spf1.dm.aliyun.com",
	"CnameRecord":"dmtrace",
	"SpfAuthStatus":1,
	"CreateTime":"2019-09-29T12:49Z",
	"RequestId":"51B74264-46B4-43C8-A9A0-6B8E8BC04F34",
	"DomainType":"0c40d5f125af4e42892a",
	"DomainName":"abc.com",
	"DomainId":158910,
	"CnameAuthStatus":1
}

Error codes

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