VerifyDomainOwner - 校验域名归属权--视频点播-火山引擎

文档中心

导航

VerifyDomainOwner - 校验域名归属权

最近更新时间：2025.03.03 10:36:03首次发布时间：2025.03.03 10:36:03

调用 VerifyDomainOwner 校验域名归属权。

使用说明

您首次通过 CreateDomain 接口添加加速域名时，需要进行域名归属权校验，以确保域名只被其真正的拥有者添加，避免域名冲突和安全隐患。视频点播支持 DNS 解析验证和文件验证两种方式。您可以任选其一完成域名归属权校验。归属权校验的具体步骤如下：

调用 DescribeDomainVerifyContent 获取归属权校验内容。
根据您选择的校验方式进行相关操作：
- 如选择 DNS 解析验证，您需要在您的域名解析服务商处添加一条记录类型为 TXT 的 DNS 记录。
- 如选择文件验证，您需要自行创建验证文件并将验证文件上传到您域名源站服务器的根目录。
说明
详细信息请见校验域名归属权。
调用 VerifyDomainOwner 进行归属权校验。
验证通过后，再调用 CreateDomain 添加加速域名。

注意事项

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

请求说明

请求地址：https://vod.volcengineapi.com?Action=VerifyDomainOwner&Version=2023-07-01

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`VerifyDomainOwner`	接口名称。当前 API 的名称为 `VerifyDomainOwner`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
Domain	String	是	`example.volcengine.com`	待校验的域名。仅支持单域名校验。
VerifyType	String	是	`dns`	校验方式，取值如下： `dns`: DNS 解析验证。 `file`: 文件验证。

返回参数

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

参数	类型	示例值	描述
ErrorMessage	String	`verify domain owner by dns error`	校验失败的原因，当 `VerifyResult` 为 `false` 时返回。 `verify domain owner by dns error`: 域名归属权 DNS 验证错误，DNS 解析失败。 `verify domain owner by dns failed, record value not match`: 域名归属权 DNS 验证错误，TXT 记录值不匹配。 `verify domain owner by file error`: 域名归属权文件验证错误，获取验证文件失败。 `verify domain owner by file failed, record value not match`: 域名归属权文件验证错误，验证文件内容不匹配。
VerifyResult	Boolean	`true`	校验是否成功： `true`: 校验成功 `false`: 校验失败

请求示例

https://vod.volcengineapi.com?Action=VerifyDomainOwner&Version=2023-07-01&Domain=example.volcengine.com&VerifyType=dns

返回示例

{
  "Result": {
    "VerifyResult": true
  },
  "ResponseMetadata": {
    "Action": "VerifyDomainOwner",
    "Region": "cn-north-1",
    "Service": "vod",
    "Version": "2023-07-01",
    "RequestId": "20230604110420****100232280022D31"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。