1. 接口描述
接口请求域名： ssl.tencentcloudapi.com 。
证书部署到云资源实例列表
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DeployCertificateInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2019-12-05。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CertificateId | 是 | String | 待部署的证书ID |
| InstanceIdList.N | 是 | Array of String | 需要部署实例列表 |
| ResourceType | 否 | String | 部署的云资源类型 |
| Status | 否 | Integer | 部署云资源状态： 云直播： -1：域名未关联证书。 1： 域名https已开启。 0： 域名https已关闭。 |
| IsCache | 否 | Integer | 是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DeployRecordId | Integer | 云资源部署任务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| DeployStatus | Integer | 部署状态，1表示部署成功，0表示部署失败 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 证书部署到clb云资源实例列表
证书部署到clb云资源实例列表， 若部署的监听器开启了SNI，则InstanceIdList传参需要到域名， 若未开启SNI， InstanceIdList只需要到监听器
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployCertificateInstance
<公共请求参数>
{
"CertificateId": "vyRlKIeI",
"InstanceIdList": [
"lb-pk278gkq|lbl-2yju432e",
"lb-mmgz14kg|lbl-5q6yn03o|clb1.ninghhuang.top"
],
"ResourceType": "clb"
}输出示例
{
"Response": {
"DeployRecordId": 1,
"DeployStatus": 0,
"RequestId": "abc"
}
}示例2 证书部署到cdn云资源实例列表
证书部署到cdn云资源域名列表
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployCertificateInstance
<公共请求参数>
{
"CertificateId": "vyRlKIeI",
"InstanceIdList": [
"cdn1.ninghhuang.top",
"cdn2.ninghhuang.top"
],
"ResourceType": "cdn"
}输出示例
{
"Response": {
"DeployRecordId": 1,
"DeployStatus": 0,
"RequestId": "abc"
}
}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 | 操作失败。 |
| FailedOperation.AuthError | 请检查是否有权限。 |
| FailedOperation.CertificateDeployHasPendingRecord | 证书部署有正在进行中的任务，请部署完成后再重试。 |
| FailedOperation.CertificateHostDeployCanNotAllow | 当前证书不允许使用一键更新的功能。 |
| FailedOperation.CertificateHostResourceInnerInterrupt | 当前为内部账号，账号涉及实例资源较多，无法使用部署功能，请联系SSL证书特殊处理。 |
| FailedOperation.CertificateHostResourceTypeInvalid | 云资源类型无效。 |
| FailedOperation.CertificateNotAvailable | 证书不可用，请检查后再试。 |
| FailedOperation.CertificateNotDeployInstance | 证书不可以部署到实例列表下。 |
| FailedOperation.CertificateNotFound | 证书不存在。 |
| FailedOperation.InvalidParam | 参数有误。 |
| FailedOperation.NoProjectPermission | 您没有该项目的操作权限。 |
| FailedOperation.NoRealNameAuth | 尚未通过实名认证。 |
| FailedOperation.RoleNotFoundAuthorization | 角色不存在，请前往授权。 |
| InternalError | 内部错误。 |
| LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |
