AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 邮件推送 API参考 API目录 域名 DescDomain - 配置域名

DescDomain - 配置域名

更新时间：
产品详情
我的收藏

配置域名。

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用前面加 * 表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
dm:DescDomainget
*全部资源
*
    无
无

请求参数

名称类型必填描述示例值
DomainIdinteger是

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

13464
RequireRealTimeDnsRecordsboolean否

判断是否要实时 DNS 解析

true

返回参数

名称类型描述示例值
object
SpfRecordstring

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

include:spf1.dm.aliyun.com
CnameConfirmStatusstring

是否改动了 CNAME 的主机记录，已改动：1（改回原来值也算改动），未改动：0。

0
DefaultDomainstring

是否为默认域名，

值：0 否（该字段已弃用）

0
CreateTimestring

创建时间

2025-03-19T12:49Z
CnameRecordstring

CNAME 主机记录自定义部分

dmtrace
CnameAuthStatusstring

CNAME 验证标志，成功：0，失败：1。

1
IcpStatusstring

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

1
DnsTxtstring

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

0c40d5f125af4e42892a
DomainNamestring

域名

test.example.net
DomainIdstring

域名 ID

158910
DnsSpfstring

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

v=xxxx
SpfAuthStatusstring

spf 验证标志，成功：0，失败：1。

1
RequestIdstring

请求 ID

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

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

mx01.dm.aliyun.com
MxAuthStatusstring

mx 验证标志，成功：0，失败：1。

1
DnsMxstring

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

mx01.dm.aliyun.com
DomainStatusstring

域名状态。说明是否验证成功，取值：

  • 0：可用，已验证通过
  • 1：不可用，验证未通过
1
TlDomainNamestring

主域名

example.com
TracefRecordstring

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

tracedm.aliyuncs.com
DomainTypestring

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

0c40d5f125af4e42892a
SpfRecordV2string

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

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

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

aliyun-cn-hangzhou._domainkey.hangzhou26
DkimPublicKeystring

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

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

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

0
HostRecordstring

主机记录

xxx
DmarcRecordstring

DMARC 记录值

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

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

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

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

1
DmarcHostRecordstring

DMARC 主机记录值

_dmarc.xxx

示例

正常返回示例

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
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-15OpenAPI 返回结构发生变更查看变更详情
2024-01-04OpenAPI 入参发生变更查看变更详情
2023-08-29OpenAPI 返回结构发生变更查看变更详情
2023-07-27OpenAPI 返回结构发生变更查看变更详情
2022-09-05OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
上一篇：CheckDomain - 验证域名下一篇：地址