校验域名归属权--veImageX-火山引擎

文档中心

导航

veImageX

校验域名归属权

最近更新时间：2025.06.10 10:32:54首次发布时间：2025.06.10 10:32:54

校验域名归属权。

您首次通过 AddDomainV1 接口添加域名时，需要进行域名归属权校验，以确保域名只被其真正的拥有者添加，避免域名冲突和安全隐患，更多关于域名归属权校验的介绍请参看校验域名归属权。veImageX 使用 DNS 解析验证的方式校验域名归属权，归属权校验的具体步骤如下：

调用 GetDomainOwnerVerifyContent 获取归属权校验内容。
根据归属权校验内容，在您的域名解析服务商处添加一条记录类型为 TXT 的 DNS 记录。
调用 VerifyDomainOwner 进行归属权校验。
验证通过后，再调用 AddDomainV1 添加域名。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=VerifyDomainOwner&Version=2023-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`VerifyDomainOwner`	接口名称。当前 API 的名称为 `VerifyDomainOwner`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数类型是否必选示例值描述

Domain String 是 test.imagex.com 待校验的域名。仅支持单域名校验。

参数	类型	是否必选	示例值	描述
Domain	String	是	`test.imagex.com`	待校验的域名。仅支持单域名校验。
VerifyType	String	是	`dns`	域名归属权的校验方式，取值如下所示。 `dns`：DNS 解析验证。

VerifyType

String

是

dns

域名归属权的校验方式，取值如下所示。

dns：DNS 解析验证。

返回参数

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

参数类型示例值描述

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

VerifyResult

Boolean

true

校验域名归属权的结果，取值如下所示。

true：校验成功；
false：校验失败。

ErrorMessage

String

verify domain owner by dns failed, record value not match

校验失败的原因，当 VerifyResult 为 false 时返回。

verify domain owner by dns error：域名归属权 DNS 验证错误，DNS 解析失败；
verify domain owner by dns failed, record value not match：域名归属权 DNS 验证错误，TXT 记录值不匹配。

请求示例

POST https://imagex.volcengineapi.com/?Action=VerifyDomainOwner&Version=2023-05-01
{
    "Domain": "test.imagex.com",
    "VerifyType": "dns"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "VerifyDomainOwner",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "VerifyResult": false,
        "ErrorMessage": "verify domain owner by dns error"
    }
}

错误码

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

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。