文档首页/ 云解析服务 DNS/ API参考/ API/ 公网域名检测/ 查询公网域名的域名诊断 - ShowDomainDetection
更新时间：2025-11-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询公网域名的域名诊断 - ShowDomainDetection

功能介绍

查询公网域名的域名诊断。

公网域名为全局资源，请选择“华北-北京四（cn-north-4）”区域调用。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    dns:zone:getDomainDetection

    Read

    zone *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

GET /v2.1/zones/{zone_id}/detection

表1 路径参数

参数

是否必选

参数类型

描述

zone_id

是

String

参数解释：

域名ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

待诊断记录集的类型。

取值范围：CNAME、TXT、MX。

domain_name

是

String

待诊断记录集的名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

获取用户Token请参见获取用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

domain_name

String

待诊断记录集的名称。

type

String

待诊断记录集的类型。

取值范围：CNAME、TXT、MX。

status

String

域名诊断状态。

取值范围：

OK：解析成功

FAILED：whois查询失败

NOT_REGISTERED：通过whois查询，域名未注册

CANNOT_RESOLVE：通过whois查询，域名无法解析

NOT_HWDNS：未托管在华为云

NO_WEBSITE_RECORD：未配置网站解析记录

NO_EMAIL_RECORD：未配置邮箱解析记录

NO_DEFAULT_VIEW：未配置默认解析

NOT_EFFECT：权威服务器未生效

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

不涉及。

message

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：500

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

不涉及。

message

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

无

响应示例

状态码：200

查询公网域名的域名诊断响应。

{
  "domain_name" : "pop3.example.com.",
  "type" : "TXT",
  "status" : "OK"
}

状态码

状态码

描述

200

查询公网域名的域名诊断响应。

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 公网域名检测

相关文档