1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
验证用户是否拥有特定直播域名。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AuthenticateDomainOwner。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainName | 是 | String | 要验证的域名。 示例值:xxx.com |
VerifyType | 是 | String | 验证类型。可取值: dnsCheck :立即验证配置 dns 的解析记录是否与待验证内容一致,成功则保存记录。 fileCheck :立即验证 web 文件是否与待验证内容一致,成功则保存记录。 dbCheck : 检查是否已经验证成功过。 示例值:dnsCheck |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Content | String | 验证内容。 VerifyType 传 dnsCheck 时,为要配的 TXT 记录值。 VerifyType 传 fileCheck 时,为文件内容。 |
Status | Integer | 域名验证状态。 >=0 为已验证归属。 <0 未验证归属权。 |
MainDomain | String | DomainName 对应的主域名。 同一主域名下的所有域名只需成功验证一次,后续均无需再验证。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AuthenticateDomainOwner
<公共请求参数>
{
"VerifyType": "dnsCheck",
"DomainName": "akxynt.cn"
}
输出示例
{
"Response": {
"Content": "cssauth_da06159efa92c365182ba5d453a7b65b",
"MainDomain": "akxynt.cn",
"RequestId": "20a9d1c1-7b2a-48b5-9a78-c0bccab3dfb6",
"Status": 0
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DomainFormatError | 域名格式错误,请输入合法格式域名。 |