全部产品
Search
文档中心

邮件推送:DescDomain - 配置域名

更新时间:Jan 07, 2026

配置域名。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dm:DescDomain

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DomainId

integer

域名 ID。可以通过 QueryDomainByParam 获取。

13464

RequireRealTimeDnsRecords

boolean

判断是否要实时 DNS 解析

true

返回参数

名称

类型

描述

示例值

object

SpfRecord

string

邮件推送控制台提供的 spf 记录值

include:spf1.dm.aliyun.com

CnameConfirmStatus

string

是否改动了 CNAME 的主机记录,已改动:1(改回原来值也算改动),未改动:0。

0

DefaultDomain

string

是否为默认域名,

值:0 否(该字段已弃用)

0

CreateTime

string

创建时间

2025-03-19T12:49Z

CnameRecord

string

CNAME 主机记录自定义部分

dmtrace

CnameAuthStatus

string

CNAME 验证标志,成功:0,失败:1。

1

IcpStatus

string

备案状态。1 表示已备案,0 表示未备案。

1

DnsTxt

string

通过公网域名解析到的所有权记录值

0c40d5f125af4e42892a

DomainName

string

域名

test.example.net

DomainId

string

域名 ID

158910

DnsSpf

string

通过公网域名解析到的 spf 记录值

v=xxxx

SpfAuthStatus

string

spf 验证标志,成功:0,失败:1。

1

RequestId

string

请求 ID

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

MxRecord

string

邮件推送控制台提供的 MX 记录值

mx01.dm.aliyun.com

MxAuthStatus

string

mx 验证标志,成功:0,失败:1。

1

DnsMx

string

通过公网域名解析到的 MX 记录值

mx01.dm.aliyun.com

DomainStatus

string

域名状态。说明是否验证成功,取值:

  • 0:可用,已验证通过

  • 1:不可用,验证未通过

1

TlDomainName

string

主域名

example.com

TracefRecord

string

邮件推送控制台提供的 CNAME 记录值

tracedm.aliyuncs.com

DomainType

string

邮件推送控制台提供的所有权记录

0c40d5f125af4e42892a

SpfRecordV2

string

spf 记录,以前 spf 展示内容需要调用端根据响应中的 spfRecord 计算得出,新增字段 spfRecordV2 取代 spfRecord, 调用端拿到该字段后可以直接进行展示;

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

DkimRR

string

DKIM 主机记录,用户需要在 dns 上设置的 dkim 记录的 key

aliyun-cn-hangzhou._domainkey.hangzhou26

DkimPublicKey

string

DKIM 公钥值,用户需要在 dns 上设置的 dkim 记录的 value

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

DkimAuthStatus

string

DKIM 验证标志,用户在 dns 设置的 dkim 记录是否已经校验通过, 0:通过, 1:未通过

0

HostRecord

string

主机记录

xxx

DmarcRecord

string

DMARC 记录值

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

DnsDmarc

string

通过公网域名解析到的 DMARC 记录值

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

DmarcAuthStatus

integer

DMARC 验证标志,用户在 dns 设置的 DMARC 记录是否已经校验通过, 0:通过, 1:未通过

1

DmarcHostRecord

string

DMARC 主机记录值

_dmarc.xxx

DkimRsaLength

integer

示例

正常返回示例

JSON格式

{
  "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": 0
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情