CheckZone - 检查域名是否符合添加条件--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CheckZone - 检查域名是否符合添加条件

最近更新时间：2025.05.19 11:04:39首次发布时间：2022.11.24 20:57:30

添加域名前，您可以使用该 API 检查域名的状态。如果检查结果符合要求，您就可以添加该域名。

使用说明

请求频率：每秒最多调用 5 次。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=CheckZone?Version=2018-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	CheckZone	要执行的操作，取值：CheckZone。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ZoneName	String	是	example.com	待检查的域名。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ZoneName	String	example.com	被检查的域名。
IsSubDomain	Boolean	false	是否是子域名。 `true`：子域名。 `false`：主域名。
Message	String	域名已存在	域名检查结果的信息。该参数有以下取值： `未查询到域名的DNS服务器配置信息`：域名检查出现异常。异常通常由以下原因造成：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。 API 在查询时超时。超时原因可能是网络问题引起的。 `域名已存在`：域名已存在于云解析 DNS 中。您无需重复添加。空字符串（""）：域名符合要求。您可以调用 CreateZone API 添加该域名。
NameServer	Array of String	["ns1.aaab-test.com","ne2.aaab-test.com"]	域名在域名注册商处分配的 NS 服务器列表。
Registered	Boolean	true	域名是否已注册。该参数有以下取值： true：域名已注册。 false：域名未注册。
ZoneOwnedByOtherUser	Boolean	false	该域名的解析管理权是否被另一个火山引擎账号持有。 true：该域名的解析管理权被另一个火山引擎账号持有。 false：该域名的解析管理权没有被其他火山引擎账号持有。

请求示例

GET /?Action=CheckZone&Version=2018-08-01&ZoneName=example.com HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240908T094252Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240908174258093252252205AE463E",
    "Action": "CheckZone",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "ZoneName": "example.com",
    "IsSubDomain": true,
    "Message": "域名已存在",
    "NameServer": [
      "ns1.aaab-test.com","ne2.aaab-test.com"
    ],
    "Registered": true,
    "ZoneOwnedByOtherUser": true
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
500	ErrInternalServer	server internal error	服务内部错误。