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

文档中心

立即注册

导航

CheckRetrieveZone - 收回域名解析管理权

最近更新时间：2025.03.10 12:00:15首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CheckRetrieveZone	要执行的操作，取值：CheckRetrieveZone。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ZoneName	String	是	example.com	待收回域名解析管理权的域名。域名必须是二级域名，并且不能是泛域名。
RetrieveType	String	否	TXT	收回域名解析管理权的方式。 TXT（默认）：通过创建一条 TXT 记录收回域名解析管理权。 Domain：通过验证该账号是否在火山引擎域名服务拥有该域名的所有权的方式在云解析 DNS 中收回域名解析管理权。

返回参数

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

参数	类型	示例值	描述
Success	String	true	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`。

请求示例 1

POST /?Action=CheckRetrieveZone&Version=2018-08-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T093345Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ZoneName": "example.com",
  "RetrieveType": "TXT"
}
text

返回示例 1

{
  "ResponseMetadata": {
    "RequestId": "20240908173350235159015238BDF994",
    "Action": "CheckRetrieveZone",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "Success": "true"
  }
}
text

请求示例 2

POST /?Action=CheckRetrieveZone&Version=2018-08-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T093439Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ZoneName": "example.com",
  "RetrieveType": "TXT"
}
text

返回示例 2

{
    "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": "验证记录未找到"
        }
    }
}
text

请求示例 3

POST /?Action=CheckRetrieveZone&Version=2018-08-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T093509Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ZoneName": "example.com",
  "RetrieveType": "Domain"
}
text

返回示例 3

{
    "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": "未找到域名"
        }
    }
}
text

错误码

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

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrZoneRetrieveNotFound	search retrieve zone not found	该域名未发起找回
400	ErrZoneRetrieveRecordExpired	zone retrieve record expired	验证记录已过期
400	ErrTXTRecordNotFound	type txt record not found	验证记录未找到
400	ErrZoneAlreadyRetrieve	zone already retrieve	域名已经被找回
400	ErrZoneNotFound	zone not found	未找到域名。
500	ErrInternalServer	server internal error	服务内部错误。

RetrieveZone - 生成域名找回 TXT 记录

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

TrafficRoute DNS 套件