DescribeRetrieveInfo--内容分发网络-火山引擎

文档中心

立即注册

导航

DescribeRetrieveInfo

最近更新时间：2025.02.10 18:21:08首次发布时间：2024.12.06 16:43:46

对于指定的域名，获取用于域名所有权校验的 TXT 记录的信息。您需要将该 TXT 记录配置在您域名的 DNS 服务商处，然后再调用 CheckDomain 或者 CheckCdnDomain 获取该域名的所有权校验结果。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=DescribeRetrieveInfo&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeRetrieveInfo`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示一个域名，获取用于域名所有权校验的 TXT 记录的信息。该域名可以是一个泛域名。	`www.example.com`

返回参数

参数名称	数据类型	参数说明	示例
Host	String	表示该 TXT 记录中的主机名。该参数值是 `volccdnauth`。	`volccdnauth`
RecordType	String	表示该 TXT 记录的记录值。	`asdfasdf`
RecordValue	String	表示该 DNS 记录的类型。该参数值是 `TXT`，表示 TXT 记录。	`TXT`

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeRetrieveInfo&Version=2021-03-01
{
    "Domain": "www.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024120612561131269DBA9126DEBDC162",
        "Action": "DescribeRetrieveInfo",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Host": "volccdnauth",
        "RecordType": "TXT",
        "RecordValue": "AmVr6hT8aOv7IQdzDC6pinvoIqYtf9gO"
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。