All Products
Search

This Product

    Direct Mail:DescDomain

    Document Center

    Direct Mail:DescDomain

    Last Updated:Mar 31, 2026

    Configure a domain name.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dm:DescDomain

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainId

    integer

    Yes

    The ID of the domain name. Call QueryDomainByParam to retrieve this ID.

    13464
    RequireRealTimeDnsRecords

    boolean

    No

    Specifies whether to perform real-time DNS resolution.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    SpfRecord

    string

    The SPF record value provided by the Direct Mail console.

    include:spf1.dm.aliyun.com
    CnameConfirmStatus

    string

    Specifies whether the CNAME host record was modified. A value of 1 indicates a modification, which includes reverting the record to its original value. A value of 0 indicates no modification.

    0
    DefaultDomain

    string

    Specifies if this is the default domain.

    This parameter is deprecated. The only valid value is 0 (No).

    0
    CreateTime

    string

    The creation time.

    2025-03-19T12:49Z
    CnameRecord

    string

    The custom part of the CNAME host record.

    dmtrace
    CnameAuthStatus

    string

    The CNAME verification status. Valid values: 0 (Verified) and 1 (Verification failed).

    1
    IcpStatus

    string

    The ICP filing status. Valid values: 1 (Filed) and 0 (Not filed).

    1
    DnsTxt

    string

    The value of the ownership record as resolved by public DNS.

    0c40d5f125af4e42892a
    DomainName

    string

    The domain name.

    test.example.net
    DomainId

    string

    The domain ID.

    158910
    DnsSpf

    string

    The value of the SPF record as resolved by public DNS.

    v=xxxx
    SpfAuthStatus

    string

    The SPF verification status. Valid values: 0 (Verified) and 1 (Verification failed).

    1
    RequestId

    string

    The request ID.

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

    string

    The MX record value provided by the Direct Mail console.

    mx01.dm.aliyun.com
    MxAuthStatus

    string

    The MX verification status. Valid values: 0 (Verified) and 1 (Verification failed).

    1
    DnsMx

    string

    The value of the MX record as resolved by public DNS.

    mx01.dm.aliyun.com
    DomainStatus

    string

    The domain verification status. Valid values:

    • 0: Verified

    • 1: Verification failed

    1
    TlDomainName

    string

    The primary domain name.

    example.com
    TracefRecord

    string

    The CNAME record value provided by the Direct Mail console.

    tracedm.aliyuncs.com
    DomainType

    string

    The required value for the ownership record, provided by the Direct Mail console.

    0c40d5f125af4e42892a
    SpfRecordV2

    string

    The complete SPF record. This parameter replaces the deprecated spfRecord, which required manual calculation. Use this value directly as your SPF record.

    v=spf1 include:spf1.dm.aliyun.com -all
    DkimRR

    string

    The host name for the DKIM record.

    aliyun-cn-hangzhou._domainkey.hangzhou26
    DkimPublicKey

    string

    The DKIM public key. This value is used for the DKIM TXT record in your DNS settings.

    v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...
    DkimAuthStatus

    string

    The verification status of the DKIM record. Valid values: 0 (Verified) and 1 (Verification failed).

    0
    HostRecord

    string

    The host record.

    xxx
    DmarcRecord

    string

    The DMARC record value.

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

    string

    The value of the DMARC record as resolved by public DNS.

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

    integer

    The verification status of the DMARC record. Valid values: 0 (Verified) and 1 (Verification failed).

    1
    DmarcHostRecord

    string

    The DMARC host record.

    _dmarc.xxx
    DkimRsaLength

    integer

    The length of the DKIM RSA key in bits, such as 1024 or 2048.

    1024

    Examples

    Success response

    JSON format

    {
  "SpfRecord": "include:spf1.dm.aliyun.com",
  "CnameConfirmStatus": "0",
  "DefaultDomain": "0",
  "CreateTime": "2025-03-19T12:49Z",
  "CnameRecord": "dmtrace",
  "CnameAuthStatus": "1",
  "IcpStatus": "1",
  "DnsTxt": "0c40d5f125af4e42892a",
  "DomainName": "test.example.net",
  "DomainId": "158910",
  "DnsSpf": "v=xxxx",
  "SpfAuthStatus": "1",
  "RequestId": "51B74264-46B4-43C8-A9A0-6B8E8BC04F34",
  "MxRecord": "mx01.dm.aliyun.com",
  "MxAuthStatus": "1",
  "DnsMx": "mx01.dm.aliyun.com",
  "DomainStatus": "1",
  "TlDomainName": "example.com",
  "TracefRecord": "tracedm.aliyuncs.com",
  "DomainType": "0c40d5f125af4e42892a",
  "SpfRecordV2": "v=spf1 include:spf1.dm.aliyun.com -all",
  "DkimRR": "aliyun-cn-hangzhou._domainkey.hangzhou26",
  "DkimPublicKey": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...",
  "DkimAuthStatus": "0",
  "HostRecord": "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",
  "DmarcAuthStatus": 1,
  "DmarcHostRecord": "_dmarc.xxx",
  "DkimRsaLength": 1024
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.