SSL 证书证书部署到云资源实例列表

1. 接口描述

接口请求域名： ssl.tencentcloudapi.com 。

证书部署到云资源实例列表，本接口只会创建部署任务，部署任务结果可通过DescribeHostDeployRecordDetail查询。本接口创建部署任务时，会校验证书和部署实例的匹配关系，存在不匹配的则会创建部署任务失败。以下为匹配关系校验规则：

若待部署的证书和传入实例域名的当前绑定的证书一致，则不会创建成功
若待部署的证书和传入域名不匹配，则不会创建成功
若部署clb实例时， 7层监听器下无规则，则不会创建成功
若部署clb实例时， 7层监听器未开启SNI，该监听器下存在任一域名和证书不匹配，则不会创建成功
若部署clb实例时，监听器规则为正则表示式，则不会创建成功

说明

一个证书ID，相同的资源类型，只能创建一个部署任务，必须等部署任务执行完成，才能创建新的部署任务

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DeployCertificateInstance。
Version	是	String	公共参数，本接口取值：2019-12-05。
Region	否	String	公共参数，此参数为可选参数。
CertificateId	是	String	待部署的证书ID 示例值：FvuXExOA
InstanceIdList.N	是	Array of String	证书部署的实例列表，不同云资源类型如下 - clb：若监听器开启了SNI，则需要指定到域名LoadBalancerId\|ListenerId\|Domain，例：["lb-bid2fs4g\|lbl-a8af11gs\|tencent.com"]，若监听器未开启SNI或者为四层监听器，则指定到监听器，例：["lb-bid2fs4g\|lbl-1c6rp5eo"] - cdn：Domain\|计费开关，例：["cdn2.tencent.com\|off", "cdn.tencent.com\|on"] - ddos：InsId\|Domain\|VirtualPort，例：["bgpip-000001ms\|tencent.com\|443"] - live：Domain，例：["live1.tencent.com", "live2.tencent.com"] - vod：Domain，例：["vod1.tencent.com", "vod2.tencent.com"] - waf：Domain，例：["waf1.tencent.com", "waf2.tencent.com"] - apigateway：ServiceId\|Domain，例：["service-8sk7cqmd\|apigw1.tencent.com", "service-8sk7cqmd\|apigw2.ninghhuang.online"] - teo：Domain，例：["edgeone1.tencent.com", "edgeone2.tencent.com"] - tke：ClusterId\|NameSpace\|SecretName，例：["cls-42sa0ae0\|default\|test-tencent"] - cos：Region\|Bucket\|Domain，例：["ap-hongkong\|ssl-server-1251810746\|tencent.com"] - lighthouse：Region\|InstanceId\|Domain，例：["ap-shanghai\|lhins-nh7lql34\|tencent.com"] - tse：GatewayId\|CertificateId，例：["gateway-s1da9151\|fa61bc05-cc54-4eea-c932-24de52577372"] - tcb：Type\|Region\|EnvId\|Domain，例：["AccessService\|ap-shanghai\|ceshi-4s5h0ymg11c839c7\|tencent.com"] 示例值：["lb-bid2fs4g\|lbl-1c6rp5eo", "lb-bid2fs4g\|lbl-a8af11gs\|tencent.com"]
ResourceType	否	String	证书部署云资源支持的云资源类型，不传则默认部署clb： - clb - cdn - ddos - live - vod - waf - apigateway - teo - tke - cos - lighthouse - tse - tcb 说明当云资源类型传入clb、waf、apigateway、cos、lighthouse、tke、tse、tcb 时，公共参数Region必传。示例值：clb
Status	否	Integer	部署云资源状态：云直播： -1：域名未关联证书。 1：域名https已开启。 0：域名https已关闭。示例值：0
IsCache	否	Integer	是否查询缓存，1：是； 0：否，默认为查询缓存，默认缓存半小时示例值：1

3. 输出参数

参数名称	类型	描述
DeployRecordId	Integer	云资源部署任务ID 示例值：773682
DeployStatus	Integer	部署任务创建状态；1表示创建成功； 0表示当前存在部署中的任务，未创建新的部署任务；返回值DeployRecordId为部署中的任务ID 示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 证书部署到clb云资源实例列表

证书部署到clb云资源实例列表，若部署的监听器开启了SNI，则InstanceIdList传参需要到域名，若未开启SNI， InstanceIdList只需要到监听器；
公共参数Region必传， Region表示操作clb对应地域的资源

输入示例

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.tencent.com"
    ],
    "ResourceType": "clb"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例2 证书部署到cdn云资源域名列表

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "cdn1.tencent.com|off",
        "cdn2.tencent.com|on"
    ],
    "ResourceType": "cdn"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例3 证书部署到edgeOne云资源域名列表

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "edgeone1.tencent.com",
        "edgeone2.tencent.com"
    ],
    "ResourceType": "teo"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例4 证书部署到ddos云资源实例列表

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "bgpip-000001ms|tencent.com|443"
    ],
    "ResourceType": "ddos"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例5 证书部署到waf域名列表

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "waf1.tencent.com",
        "waf2.tencent.com"
    ],
    "ResourceType": "waf"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例6 证书部署到云直播域名列表

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "live1.tencent.com",
        "live2.tencent.com"
    ],
    "ResourceType": "live"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例7 证书部署到apigateway云资源域名列表

公共参数Region必传， Region表示操作api网关对应地域的资源

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "service-8sk7cqmd|apigw1.tencent.com",
        "service-8sk7cqmd|apigw2.tencent.com"
    ],
    "ResourceType": "apigateway"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例8 证书部署到tke云资源实例列表

公共参数Region必传， Region表示操作tke对应地域的资源

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "cls-42sa0ae0|default|test-tencent"
    ],
    "ResourceType": "tke"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例9 证书部署到cos云资源实例列表

公共参数Region必传， Region表示操作cos对应地域的资源

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "ap-hongkong|ssl-server-1251810746|tencent.com"
    ],
    "ResourceType": "cos"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例10 证书部署到lighthouse云资源实例列表

公共参数Region必传， Region表示操作lighthouse对应地域的资源

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "ap-shanghai|lhins-nh7lql34|tencent.com"
    ],
    "ResourceType": "lighthouse"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例11 证书部署到tse云资源实例列表

公共参数Region必传， Region表示操作tse对应地域的资源

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "gateway-s1da9151|fa61bc05-cc54-4eea-c932-24de52577372"
    ],
    "ResourceType": "tse"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例12 证书部署到tcb云资源实例列表

公共参数Region必传， Region表示操作tcb对应地域的资源

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "AccessService|ap-shanghai|ceshi-4s5h0ymg11c839c7|tencent.com"
    ],
    "ResourceType": "tcb"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例13 证书部署到云点播域名列表

输入示例

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

{
    "CertificateId": "vyRlKIeI",
    "InstanceIdList": [
        "vod1.tencent.com",
        "vod2.tencent.com"
    ],
    "ResourceType": "vod"
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.AuthError	请检查是否有权限。
FailedOperation.CertificateDeployHasPendingRecord	证书部署有正在进行中的任务，请部署完成后再重试。
FailedOperation.CertificateDeployInstanceFormatError	部署格式错误
FailedOperation.CertificateHostDeployCanNotAllow	当前证书不允许使用一键更新的功能。
FailedOperation.CertificateHostResourceInnerInterrupt	当前为内部账号，账号涉及实例资源较多，无法使用部署功能，请联系SSL证书特殊处理。
FailedOperation.CertificateHostResourceTypeInvalid	云资源类型无效。
FailedOperation.CertificateNotAvailable	证书不可用，请检查后再试。
FailedOperation.CertificateNotDeployInstance	证书不可以部署到实例列表下。
FailedOperation.CertificateNotFound	证书不存在。
FailedOperation.InvalidParam	参数有误。
FailedOperation.NoProjectPermission	您没有该项目的操作权限。
FailedOperation.NoRealNameAuth	尚未通过实名认证。
FailedOperation.RoleNotFoundAuthorization	角色不存在，请前往授权。
InternalError	内部错误。
InvalidParameter.RegionNotEmpty	Region不允许为空
LimitExceeded.RateLimitExceeded	单位时间内接口请求频率达到限制。

证书部署到云资源实例列表

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 证书部署到clb云资源实例列表

输入示例

输出示例

示例2 证书部署到cdn云资源域名列表

输入示例

输出示例

示例3 证书部署到edgeOne云资源域名列表

输入示例

输出示例

示例4 证书部署到ddos云资源实例列表

输入示例

输出示例

示例5 证书部署到waf域名列表

输入示例

输出示例

示例6 证书部署到云直播域名列表

输入示例

输出示例

示例7 证书部署到apigateway云资源域名列表

输入示例

输出示例

示例8 证书部署到tke云资源实例列表

输入示例

输出示例

示例9 证书部署到cos云资源实例列表

输入示例

输出示例

示例10 证书部署到lighthouse云资源实例列表

输入示例

输出示例

示例11 证书部署到tse云资源实例列表

输入示例

输出示例

示例12 证书部署到tcb云资源实例列表

输入示例

输出示例

示例13 证书部署到云点播域名列表

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码