RetrieveZone - 生成域名找回 TXT 记录--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

RetrieveZone - 生成域名找回 TXT 记录

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

生成用于收回域名解析管理权的 TXT 记录。参见常见问题了解如何收回域名解析管理权。

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	RetrieveZone	要执行的操作，取值：RetrieveZone。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ZoneName	String	是	example.com	待收回解析管理权的域名。域名必须是二级域名，并且不能是泛域名。

返回参数

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

参数	类型	示例值	描述
Host	String	volc-retrieva	TXT 记录的域名前缀。
IsOwnedByDomain	Boolean	true	当前火山引擎主账号是否在火山引擎域名服务拥有该域名的所有权。 true：当前火山引擎主账号在火山引擎域名服务拥有该域名的所有权。 false：当前火山引擎主账号没有该域名的所有权。
Txt	String	verify-4ea49976-59ab-11ed-b66f-00163e12d591	TXT 记录的记录值。
ZoneName	String	example.com	待收回解析管理权的域名。

请求示例

POST /?Action=RetrieveZone&Version=2018-08-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T092212Z
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"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202409081722292372550272368296B5",
    "Action": "RetrieveZone",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "Host": "volc-retrieva",
    "IsOwnedByDomain": true,
    "Txt": "verify-4ea49976-59ab-11ed-b66f-00163e12d591",
    "ZoneName": "example.com"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrZoneNotFound	zone not found	未找到域名。
400	ErrCreateRetrieveTxtReachingMaxTimes	create retrieve txt record reaching max times	验证记录生成次数超出限制。
500	ErrInternalServer	server internal error	服务内部错误。