有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

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, 查询绑定该证书的云资源然后进行证书更新
ResourceTypes.N Array of String 需要部署的资源类型,参数值可选(小写):clb、cdn、waf、live、ddos、teo、apigateway、vod、tke、tcb、tse
CertificateId String 一键更新新证书ID,不传该则证书公钥和私钥必传
ResourceTypesRegions.N Array of ResourceTypeRegions 云资源需要部署的地域列表,支持地域的云资源类型必传,如:clb、tke、apigateway、waf、tcb、tse等
CertificatePublicKey String 证书公钥, 若上传证书公钥, 则CertificateId不用传
CertificatePrivateKey String 证书私钥,若上传证书公钥, 则CertificateId不用传
ExpiringNotificationSwitch Integer 旧证书是否忽略到期提醒 0:不忽略通知。1:忽略通知,忽略OldCertificateId到期提醒
Repeatable Boolean 相同的证书是否允许重复上传,若选择上传证书, 则可以配置该参数
AllowDownload Boolean 是否允许下载,若选择上传证书, 则可以配置该参数
Tags.N Array of Tags 标签列表,若选择上传证书, 则可以配置该参数
ProjectId Integer 项目 ID,若选择上传证书, 则可以配置该参数

3. 输出参数

参数名称 类型 描述
DeployRecordId Integer 云资源部署任务ID
注意:此字段可能返回 null,表示取不到有效值。
DeployStatus Integer 部署状态,1表示部署成功,0表示部署失败
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": "abc",
    "OldCertificateId": "abc",
    "ResourceTypes": [
        "abc"
    ],
    "Regions": [
        "abc"
    ],
    "ResourceTypesRegions": [
        {
            "ResourceType": "abc",
            "Regions": [
                "abc"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DeployRecordId": 1,
        "DeployStatus": 0,
        "UpdateSyncProgress": [
            {
                "ResourceType": "abc",
                "UpdateSyncProgressRegions": [
                    {
                        "Region": "abc",
                        "TotalCount": 0,
                        "OffsetCount": 0,
                        "Status": "abc"
                    }
                ],
                "Status": 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。

命令行工具

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 参数有误。
LimitExceeded.RateLimitExceeded 单位时间内接口请求频率达到限制。