API 文档

添加域名

最近更新时间:2021-08-24 08:07:44

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

添加域名,一次只能提交一个域名。域名必须已备案。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddLiveDomain。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
DomainName String 域名名称。
DomainType Integer 域名类型,
0:推流域名,
1:播放域名。
PlayType Integer 拉流域名类型:
1:国内,
2:全球,
3:境外。
默认值:1。
IsDelayLive Integer 是否是慢直播:
0: 普通直播,
1 :慢直播 。
默认值: 0。
IsMiniProgramLive Integer 是否是小程序直播:
0: 标准直播,
1 :小程序直播 。
默认值: 0。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加域名

输入示例

https://live.tencentcloudapi.com/?Action=AddLiveDomain
&DomainName=www.test.com
&DomainType=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
FailedOperation.DeleteDomainInLockedTime 2天内有产生流量,域名处于锁定期间,2天内无流量产生才允许删除域名。
FailedOperation.HostOutLimit 域名数量超过限制(100个)。
InternalError 内部错误。
InternalError.ChineseCharacterDetected 暂不支持添加中文域名,请核对域名格式。
InternalError.ConnectDbError DB 连接错误。
InternalError.DBError DB执行错误。
InternalError.DomainAlreadyExist 该域名已在其他处接入,请检查域名是否输入正确。 如域名正确,您可通过验证后重新添加域名。
InternalError.DomainFormatError 域名格式错误,请输入合法格式域名。
InternalError.DomainGslbFail 添加 GSLB 规则失败。
InternalError.DomainIsFamous 该域名已在其他处接入,请检查域名是否输入正确。 如域名正确,您可通过验证后重新添加域名。
InternalError.DomainIsLimited 您的域名不可用,请输入正确的域名。
InternalError.DomainNoRecord 域名没有备案。
InternalError.DomainTooLong 域名长度超过限制。
InternalError.InvalidInput 参数检校不通过。
InternalError.InvalidUser 账号信息错误。
InternalError.NetworkError 内部网络错误。
InvalidParameter.DomainAlreadyExist 域名已经存在。
InvalidParameter.DomainFormatError 域名格式错误,请输入合法格式域名。
InvalidParameter.DomainHitBlackList 当前域名在黑名单中。
InvalidParameter.DomainIsFamous 使用黑名单域名。
InvalidParameter.DomainIsLimited 域名受限,请提交工单,申请解除限制。
InvalidParameter.DomainTooLong 域名长度超过限制。
InvalidParameter.MpHostDelete 当月不允许添加已删除的小程序域名。
InvalidParameter.MpPluginNoUse 小程序插件没有授权。
ResourceNotFound.DomainNoRecord 域名没有备案。
ResourceNotFound.InvalidUser 用户不支持此接口。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
目录