上传证书

最近更新时间:2024-05-20 02:06:26

我的收藏

1. 接口描述

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

本接口(UploadCertificate)用于上传证书。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UploadCertificate。
Version String 公共参数,本接口取值:2019-12-05。
Region String 公共参数,本接口不需要传递此参数。
CertificatePublicKey String 证书内容。
CertificatePrivateKey String 私钥内容,证书类型为 SVR 时必填,为 CA 时可不填。
CertificateType String 证书类型,默认 SVR。CA = CA证书,SVR = 服务器证书。
Alias String 备注名称。
ProjectId Integer 项目 ID。
CertificateUse String 证书用途/证书来源。“CLB,CDN,WAF,LIVE,DDOS”
Tags.N Array of Tags 标签列表
Repeatable Boolean 相同的证书是否允许重复上传
示例值:true

3. 输出参数

参数名称 类型 描述
CertificateId String 证书 ID。
RepeatCertId String 重复证书的ID
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 上传证书CA证书

上传证书根证书

输入示例

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

{
    "CertificatePublicKey": "-----BEGIN CERTIFICATE-----\nxxxxxxxxxxxxxxxxxxx\n-----END CERTIFICATE-----",
    "Alias": "上传CA证书",
    "ProjectId": "12345",
    "Repeatable": false,
    "CertificateType": "CA",
    "Tags": [
        {
            "TagKey": "key1",
            "TagValue": "value1"
        },
        {
            "TagKey": "key2",
            "TagValue": "value2"
        }
    ]
}

输出示例

{
    "Response": {
        "CertificateId": "a92b1Z1i",
        "RepeatCertId": "",
        "RequestId": "7ef2d2bb-f609-4e3d-a35c-04a5d3ac633b"
    }
}

示例2 上传服务端证书

上传服务端证书

输入示例

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

{
    "CertificatePublicKey": "-----BEGIN CERTIFICATE-----\nxxxxxxxxxxxxxxxxxxx\n-----END CERTIFICATE-----",
    "CertificatePrivateKey": "-----BEGIN RSA PRIVATE KEY-----\r\nxxxxxxxxxxxxxxxxxxxxxxxx\r\n-----END RSA PRIVATE KEY-----",
    "Alias": "上传证书",
    "ProjectId": "12345",
    "Repeatable": false,
    "CertificateType": "SVR",
    "Tags": [
        {
            "TagKey": "key1",
            "TagValue": "value1"
        },
        {
            "TagKey": "key2",
            "TagValue": "value2"
        }
    ]
}

输出示例

{
    "Response": {
        "CertificateId": "DSAuy46E",
        "RepeatCertId": "DSAuy46E",
        "RequestId": "6d69e2d8-2c31-40d2-a244-9f86ffb20cd0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 操作未授权。
FailedOperation 操作失败。
FailedOperation.AuthError 请检查是否有权限。
FailedOperation.CAMAuthorizedFail CAM鉴权出现错误。
FailedOperation.CancelOrderFailed 取消订单失败。
FailedOperation.CannotBeDeletedIssued 该证书已颁发, 不能删除。
FailedOperation.CannotBeDeletedWithinHour 免费证书申请1小时内不允许删除。
FailedOperation.CannotGetOrder 获取订单信息失败,请稍后重试。
FailedOperation.CertificateCaError 温馨提示:上传的证书内容不符合CA证书的标准格式,请您核对证书类型是否有误
FailedOperation.CertificateEncryptInvalid 证书内容疑似国密证书,与所选证书标准不符,请您核对选择的证书标准和证书内容是否有误
FailedOperation.CertificateExists 证书已存在。
FailedOperation.CertificateInvalid 证书不符合标准。
FailedOperation.CertificateMatchError 温馨提示:证书内容和私钥不匹配,请您核对(请留意是否有多余的空格)
FailedOperation.CertificateMismatch 证书与私钥不对应。
FailedOperation.CertificateNotFound 证书不存在。
FailedOperation.CertificateParseError 解析失败,请检查证书是否符合标准,请留意是否有多余的空格
FailedOperation.ExceedsFreeLimit 免费证书数量超出限制。
FailedOperation.InvalidCertificateStatusCode 证书状态不正确。
FailedOperation.InvalidParam 参数有误。
FailedOperation.NetworkError 当前 CA 机构访问繁忙,请稍后重试。
FailedOperation.NoProjectPermission 您没有该项目的操作权限。
FailedOperation.NoRealNameAuth 尚未通过实名认证。
FailedOperation.OrderAlreadyReplaced 该订单已重签发。
FailedOperation.OrderReplaceFailed 重颁发失败。
InternalError 内部错误。
InvalidParameter.MissMatchPrivateKey 没有匹配的私钥。
InvalidParameter.WithDetailReason 参数有误。
LimitExceeded.RateLimitExceeded 单位时间内接口请求频率达到限制。