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

文档中心

立即注册

导航

TrafficRoute DNS 套件

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

最近更新时间：2024.06.27 20:40:53首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`CheckZone`	API 的名称。该参数的取值是 `CheckZone`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。
ZoneName	String	是	`example`	待检查的域名。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在区域。

Result 对象

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

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=CheckZone&ZoneName=example.com

返回示例

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

错误码

您可访问公共错误码，获取详细信息。