You can call the DescDomain operation to query the configuration of a domain name.
Test the operation
You can test this operation in OpenAPI Explorer. You do not need to calculate a signature. After a successful call, OpenAPI Explorer automatically generates software development kit (SDK) code examples.
Request parameters
Name | Type | Required | Example | Description |
DomainId | Integer | Yes | 13464 | The ID of the domain name. To obtain the domain name ID, call the QueryDomainByParam operation. |
Action | String | No | DescDomain | A required parameter. Set the value to DescDomain. |
RequireRealTimeDnsRecords | boolean | No | true | Specifies whether to perform real-time DNS resolution. |
Response parameters
Name | Type | Example | Description |
SpfRecord | String | include the following:spf1.dm.aliyun.com | The SPF record value that is provided in the Direct Mail console. |
CnameConfirmStatus | String | 0 | Indicates whether the CNAME host record was changed. A value of 1 indicates that the record was changed. This includes changing the record back to its original value. A value of 0 indicates that the record was not changed. |
DefaultDomain | String | 0 | Indicates whether the domain name is the default domain name. Value: 0 (No). This parameter is deprecated. |
CreateTime | String | 2019-09-29T12:49Z | Created at |
CnameRecord | String | dmtrace | The custom part of the CNAME host record. |
CnameAuthStatus | String | 1 | The CNAME verification flag. A value of 0 indicates success and a value of 1 indicates failure. |
IcpStatus | String | 1 | The ICP filing status. A value of 1 indicates that the domain name has an ICP filing. A value of 0 indicates that the domain name does not have an ICP filing. |
DnsTxt | String | 0c40d5f125af4e42892a | The ownership record value that is obtained through DNS resolution over the internet. |
DomainName | String | test.example.net | The domain name. |
DomainId | String | 158910 | The domain name ID. |
DnsSpf | String | v=xxxx | The SPF record value that is obtained through DNS resolution over the internet. |
SpfAuthStatus | String | 1 | The SPF verification flag. A value of 0 indicates success and a value of 1 indicates failure. |
RequestId | String | 51B74264-46B4-43C8-A9A0-6B8E8BC04F34 | The request ID. |
MxRecord | String | mx01.dm.aliyun.com | The MX record value that is provided in the Direct Mail console. |
MxAuthStatus | String | 1 | The MX verification flag. A value of 0 indicates success and a value of 1 indicates failure. |
DnsMx | String | mx01.dm.aliyun.com | The MX record value that is obtained through DNS resolution over the internet. |
DomainStatus | String | 1 | The status of the domain name. This parameter indicates whether the domain name is verified. Valid values: 0: Active and verified. 1: Inactive and verification failed. |
TlDomainName | String | example.net | The primary domain name. |
TracefRecord | String | tracedm.aliyuncs.com | The CNAME record value that is provided in the Direct Mail console. |
DomainType | String | 0c40d5f125af4e42892a | The ownership record that is provided in the Direct Mail console. |
SpfRecordV2 | String | v=spf1 include the following:spf1.dm.aliyun.com -all | The SPF record value. |
DkimRR | String | aliyun-cn-hangzhou._domainkey.xxx | The DKIM host record. |
DkimPublicKey | String | v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb... | The DKIM public key. |
DkimAuthStatus | String | 1 | The DKIM verification flag. A value of 0 indicates success and a value of 1 indicates failure. |
HostRecord | String | xxx | The host record. |
DmarcHostRecord | String | _dmarc.xxx | The DMARC host record. |
DmarcRecord | String | v=DMARC1;p=none;rua=mailto:dmarc_report@service.aliyun.com | The DMARC record. |
DnsDmarc | String | v=DMARC1;p=none;rua=mailto:dmarc_report@service.aliyun.com | The DMARC record value that is obtained through DNS resolution over the internet. |
DmarcAuthStatus | Integer | 1 | The DMARC verification flag. A value of 0 indicates success and a value of 1 indicates failure. |
Examples
Request example
http(s)://dm.aliyuncs.com/?Action=DescDomain
&DomainId=401591
&<Common request parameters>Response example
JSON format
{
"HostRecord": "dmailtest",
"CnameAuthStatus": 1,
"CnameRecord": "dmtrace",
"IcpStatus": 1,
"DefaultDomain": 0,
"DomainType": "df29ab561bb140e98dfb",
"SpfRecordV2": "v=spf1 include the following:spf1.dm.aliyun.com -all",
"DkimRR": "aliyun-cn-hangzhou._domainkey.dmailtest",
"TlDomainName": "sdysy.top",
"SpfRecord": "include the following: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 the following: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. | The specified domain ID does not exist. |
For a complete list of error codes, see the Error Center.