1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
一键更新旧证书资源,本接口为异步接口, 调用之后DeployRecordId为0表示任务进行中, 重复请求这个接口, 当返回DeployRecordId大于0则表示任务创建成功。 未创建成功则会抛出异常
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateCertificateInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
OldCertificateId | 是 | String | 一键更新的旧证书ID。 通过查询该证书ID绑定的云资源,然后使用新证书对这些云资源进行更新 示例值:hey**shje |
ResourceTypes.N | 是 | Array of String | 需要部署的资源类型,参数值可选(小写):clb、cdn、waf、live、ddos、teo、apigateway、vod、tke、tcb、tse、cos 示例值:["clb","tke"] |
CertificateId | 否 | String | 一键更新的新证书ID。 不传该参数,则公钥证书和私钥证书必传 示例值:hey**shje |
ResourceTypesRegions.N | 否 | Array of ResourceTypeRegions | 云资源需要部署的地域列表,支持地域的云资源类型必传,取值:clb、tke、apigateway、waf、tcb、tse、cos |
CertificatePublicKey | 否 | String | 公钥证书, 若上传公钥证书,那么私钥证书必传。 则CertificateId不用传 示例值:-----BEGIN CERTIFICATE----**** |
CertificatePrivateKey | 否 | String | 私钥证书,若上传私钥证书, 那么公钥证书必传; 则CertificateId不用传 示例值:-----BEGIN RSA PRIVATE KEY----*** |
ExpiringNotificationSwitch | 否 | Integer | 旧证书是否忽略到期提醒 0:不忽略通知。1:忽略通知,忽略OldCertificateId到期提醒 示例值:1 |
Repeatable | 否 | Boolean | 相同的证书是否允许重复上传,若选择上传公钥私钥证书, 则可以配置该参数。 若存在相同重复证书,则更新任务会失败 示例值:true |
AllowDownload | 否 | Boolean | 是否允许下载,若选择上传公私钥证书, 则可以配置该参数 示例值:true |
Tags.N | 否 | Array of Tags | 标签列表,若选择上传公私钥证书, 则可以配置该参数 |
ProjectId | 否 | Integer | 项目 ID,若选择上传公私钥证书, 则可以配置该参数 示例值:1788 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DeployRecordId | Integer | 云资源更新任务ID, DeployRecordId为0表示任务进行中, 重复请求这个接口, 当返回DeployRecordId大于0则表示任务创建成功。 未创建成功则会抛出异常 注意:此字段可能返回 null,表示取不到有效值。 示例值:17636 |
DeployStatus | Integer | 更新任务创建状态;1表示创建成功; 0表示当前存在更新中的任务,未创建新的更新任务;返回值DeployRecordId为更新中的任务ID 示例值:1 |
UpdateSyncProgress | Array of UpdateSyncProgress | 更新异步创建任务进度详情 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 一键更新旧证书资源
一键更新旧证书资源
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCertificateInstance
<公共请求参数>
{
"CertificateId": "Th**jj",
"OldCertificateId": "gej**kkk",
"ResourceTypes": [
"clb"
],
"Regions": [
"ap-guangzhou"
],
"ResourceTypesRegions": [
{
"ResourceType": "clb",
"Regions": [
"ap-guangzhou"
]
}
]
}
输出示例
{
"Response": {
"DeployRecordId": 1763489,
"DeployStatus": 0,
"UpdateSyncProgress": [
{
"ResourceType": "clb",
"UpdateSyncProgressRegions": [
{
"Region": "ap-guangzhou",
"TotalCount": 0,
"OffsetCount": 0,
"Status": 0
}
],
"Status": 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AuthError | 请检查是否有权限。 |
FailedOperation.CertificateDeployHasPendingRecord | 证书部署有正在进行中的任务,请部署完成后再重试。 |
FailedOperation.CertificateDeployInstanceEmpty | 已选择的云资源无实例,无法更新,请重新核对后重试。 |
FailedOperation.CertificateExists | 证书已存在。 |
FailedOperation.CertificateHostDeployCanNotAllow | 当前证书不允许使用一键更新的功能。 |
FailedOperation.CertificateHostResourceInnerInterrupt | 当前为内部账号,账号涉及实例资源较多,无法使用部署功能,请联系SSL证书特殊处理。 |
FailedOperation.CertificateHostResourceInstanceHugeLimit | 当前账号下实例数量过多,无法正常加载,请您切换加载方式。切换后点击“刷新列表”等待一段时间后即可全部加载。 |
FailedOperation.CertificateHostResourceTypeInvalid | 云资源类型无效。 |
FailedOperation.CertificateInvalid | 证书不符合标准。 |
FailedOperation.CertificateMatchError | 温馨提示:证书内容和私钥不匹配,请您核对(请留意是否有多余的空格) |
FailedOperation.CertificateNotAvailable | 证书不可用,请检查后再试。 |
FailedOperation.CertificateNotDeployInstance | 证书不可以部署到实例列表下。 |
FailedOperation.CertificateNotFound | 证书不存在。 |
FailedOperation.CertificateParseError | 解析失败,请检查证书是否符合标准,请留意是否有多余的空格 |
FailedOperation.InvalidParam | 参数有误。 |
FailedOperation.NoProjectPermission | 您没有该项目的操作权限。 |
FailedOperation.NoRealNameAuth | 尚未通过实名认证。 |
FailedOperation.RoleNotFoundAuthorization | 角色不存在,请前往授权。 |
InternalError | 内部错误。 |
InvalidParameter.WithDetailReason | 参数有误。 |
InvalidParameterValue.IntermediateCertNotSame | 中间根证书不一致 |
LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |