DescDomain - 配置域名_邮件推送(Direct Mail)-阿里云帮助中心

配置域名。

调试

您可以在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 验证标志，成功：0，失败：1。	0
DefaultDomain	string	默认域名	0
CreateTime	string	创建时间	2019-09-29T12:49Z
CnameRecord	string	CNAME 记录	dmtrace
CnameAuthStatus	string	track 验证	1
IcpStatus	string	备案状态。1 表示已备案，0 表示未备案。	1
DnsTxt	string	所有权记录	121309ohdsa
DomainName	string	域名	abc.com
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 记录值	abc-com.xxxx.com
DomainStatus	string	域名状态。说明是否验证成功，取值： 0：可用，已验证通过 1：不可用，验证未通过	1
TlDomainName	string	主域名	abc.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	用户需要在 dns 上设置的 dkim 记录的 key	aliyun-cn-hangzhou._domainkey.hangzhou26
DkimPublicKey	string	用户需要在 dns 上设置的 dkim 记录的 value	v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...
DkimAuthStatus	string	用户在 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	用户在 dns 设置的 DMARC 记录是否已经校验通过, 0:通过， 1:未通过	1
DmarcHostRecord	string	DMARC 主机记录值	_dmarc.xxx

示例

正常返回示例

JSON格式

{
  "SpfRecord": "include:spf1.dm.aliyun.com",
  "CnameConfirmStatus": "0",
  "DefaultDomain": "0",
  "CreateTime": "2019-09-29T12:49Z",
  "CnameRecord": "dmtrace",
  "CnameAuthStatus": "1",
  "IcpStatus": "1",
  "DnsTxt": "121309ohdsa",
  "DomainName": "abc.com",
  "DomainId": "158910",
  "DnsSpf": "v=xxxx",
  "SpfAuthStatus": "1",
  "RequestId": "51B74264-46B4-43C8-A9A0-6B8E8BC04F34",
  "MxRecord": "mx01.dm.aliyun.com",
  "MxAuthStatus": "1",
  "DnsMx": "abc-com.xxxx.com",
  "DomainStatus": "1",
  "TlDomainName": "abc.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"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-15	OpenAPI 返回结构发生变更	查看变更详情
2024-01-04	OpenAPI 入参发生变更	查看变更详情
2023-08-29	OpenAPI 返回结构发生变更	查看变更详情
2023-07-27	OpenAPI 返回结构发生变更	查看变更详情
2022-09-05	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情