有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > 云直播 > API 文档 > 证书管理相关接口 > 批量绑定证书对应的播放域名

1. 接口描述

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

批量绑定证书对应的播放域名,并更新启用状态。
新建自有证书将自动上传至腾讯云ssl。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyLiveDomainCertBindings。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
DomainInfos.N Array of LiveCertDomainInfo 要绑定证书的播放域名/状态 信息列表。
如果CloudCertId和证书公钥私钥对均不传,且域名列表已有绑定规则,只批量更新域名https规则的启用状态,并把未上传至腾讯云ssl的已有自有证书上传。
CloudCertId String 腾讯云ssl的证书Id。
见 https://cloud.tencent.com/document/api/400/41665
CertificatePublicKey String 证书公钥。
CloudCertId和公钥私钥对二选一,若CloudCertId将会舍弃公钥和私钥参数,否则将自动先把公钥私钥对上传至ssl新建证书,并使用上传成功后返回的CloudCertId。
CertificatePrivateKey String 证书私钥。
CloudCertId和公钥私钥对二选一,若传CloudCertId将会舍弃公钥和私钥参数,否则将自动先把公钥私钥对上传至ssl新建证书,并使用上传成功后返回的CloudCertId。
CertificateAlias String 上传至ssl证书中心的备注信息,只有新建证书时有效。传CloudCertId时会忽略。

3. 输出参数

参数名称 类型 描述
MismatchedDomainNames Array of String DomainNames 入参中,与证书不匹配的域名列表,将会跳过处理。
Errors Array of BatchDomainOperateErrors 操作失败的域名及错误码,错误信息,包括MismatchedDomainNames中的域名。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLiveDomainCertBindings
<公共请求参数>

{
    "CloudCertId": "hZy2N9vF",
    "DomainInfos": [
        {
            "DomainName": "abc.tst.com.cn",
            "Status": 1
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "cb91d382-e9be-4688-9008-d57088271b5f",
        "MismatchedDomainNames": [],
        "Errors": []
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.AuthError 请检查是否有权限。
FailedOperation.CannotBeDeletedIssued 该证书已颁发,不能删除。
FailedOperation.CannotBeDeletedWithinHour 免费证书申请1小时内不允许删除。
FailedOperation.CertificateExists 证书已存在。
FailedOperation.CertificateInvalid 证书不符合标准。
FailedOperation.CertificateMismatch 证书与私钥不对应。
FailedOperation.CertificateNotFound 证书不存在。
FailedOperation.ConfigCDNFailed 下发CDN平台失败。
FailedOperation.ExceedsFreeLimit 免费证书数量超出限制。
FailedOperation.InvalidCertificateStatusCode 证书状态不正确。
FailedOperation.InvalidParam 参数有误。
FailedOperation.NetworkError 当前 CA 机构访问繁忙,请稍后重试。
FailedOperation.NoProjectPermission 您没有该项目的操作权限。
FailedOperation.NoRealNameAuth 尚未通过实名认证。
InternalError 内部错误。
InternalError.ConnectDbError DB 连接错误。
InternalError.CrtDateInUsing 证书使用中。
InternalError.CrtDateNotFound 证书不存在。
InternalError.CrtDateNotLegal 证书不合法。
InternalError.CrtDateOverdue 证书过期。
InternalError.CrtDomainNotFound 没有相关域名。
InternalError.CrtKeyNotMatch 证书 Key 不匹配。
InternalError.DBError DB执行错误。
InternalError.NetworkError 内部网络错误。
InvalidParameter 参数错误。
InvalidParameter.CloudCrtIdError 腾讯云证书托管 ID 错误。
InvalidParameter.CrtDateInUsing 证书使用中。
InvalidParameter.CrtDateNotFound 证书不存在。
InvalidParameter.CrtDateNotLegal 证书内容不合法。
InvalidParameter.CrtDateOverdue 证书过期。
InvalidParameter.CrtDomainNotFound 证书没有相关域名。
InvalidParameter.CrtKeyNotMatch 证书 Key 不匹配。
InvalidParameter.CrtOrKeyNotExist 证书内容或者私钥未提供。
LimitExceeded.RateLimitExceeded 单位时间内接口请求频率达到限制。
ResourceNotFound.CrtDateNotFound 证书不存在。
ResourceNotFound.CrtDomainNotFound 未找到证书信息。
ResourceNotFound.DomainNotExist 域名不存在或不匹配。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。