CheckRetrieveZone-收回域名解析管理权--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CheckRetrieveZone-收回域名解析管理权

最近更新时间：2024.06.27 14:33:48首次发布时间：2022.11.24 20:57:30

收回域名解析管理权。参见常见问题了解如何收回域名解析管理权。

使用说明

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`CheckRetrieveZone`	API 的名称。该参数的取值是 `CheckRetrieveZone`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。

Body

名称	类型	是否必选	示例值	描述
ZoneName	String	是	`example.com`	待收回域名解析管理权的域名。域名必须是二级域名，并且不能是泛域名。
RetrieveType	String	否	`TXT`	收回域名解析管理权的方式。 TXT（默认）：通过创建一条 TXT 记录收回域名解析管理权。 Domain：通过验证该账号是否在火山引擎域名服务拥有该域名的所有权的方式在云解析 DNS 中收回域名解析管理权。

返回参数

ResponseMetadata 对象

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

Result 对象

RetrieveType 是 TXT

如果收回域名解析管理权成功，该 API 返回 "Success": "true"。如果收回域名解析管理权失败，该 API 不返回 Result 对象。同时，该 API 通过 ResponseMetadata 对象返回错误消息 type TXT record not found。

RetrieveType 是 Domain

如果收回域名解析管理权成功，该 API 返回 "Success": "true"。如果收回域名解析管理权失败，该 API 不返回 Result 对象。同时，该 API 通过 ResponseMetadata 对象返回错误消息 zone not found。

示例

请求示例

POST https://open.volcengineapi.com?Version=2018-08-01&Action=CheckRetrieveZone
{
  "ZoneName": "example.com",
  "RetrieveType": "TXT"
}

响应示例

成功收回域名解析管理权

{
    "ResponseMetadata": {
        "RequestId": "20221101155301010225243125056CA34D",
        "Action": "CheckRetrieveZone",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "Success": "true"
    }
}

RetrieveType 是 TXT，收回域名解析管理权失败

{
    "ResponseMetadata": {
        "RequestId": "20211215202125010225243125052DB635",
        "Action": "CheckRetrieveZone",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 400125,
            "Code": "ErrTXTRecordNotFound",
            "Message": "type txt record not found",
            "MessageCN": "验证记录未找到"
        }
    }
}

RetrieveType 是 Domain，收回域名解析管理权失败

{
    "ResponseMetadata": {
        "RequestId": "20211215202125010225243125052DB635",
        "Action": "CheckRetrieveZone",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 400105,
            "Code": "ErrZoneNotFound",
            "Message": "zone not found",
            "MessageCN": "未找到域名"
        }
    }
}

错误码

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