文档中心

上传证书

最近更新时间：2024.04.19 16:37:27

首次发布时间：2024.01.02 15:54:55

API说明

API名称：ImportCertificate。
API域名：open.volcengineapi.com。
API描述：调用本接口向证书中心上传一本SSL证书。

您可以上传一本采用SM2密钥算法的国密证书，或者上传一本采用RSA或ECC密钥算法的非国密证书。
您必须同时上传证书文件和私钥文件。

请求方法

POST

使用限制

QPS限制：同一个租户每秒最多允许请求20次。
您上传的证书必须是有效的。证书有效表示证书未过期、未被吊销。

公共参数

下方表格中的公共参数必须包含在请求头（header）中。

参数名称	数据类型	是否必选	参数说明
Region	String	是	服务地区。该参数的取值是`cn-north-1`。
ServiceName	String	是	服务名称。该参数的取值是`certificate_service`。

下方表格中的公共参数必须包含在查询字符串（query string）中。

参数名称	数据类型	是否必选	参数说明
Action	String	是	API名称。该参数的取值是`ImportCertificate`。
Version	String	是	API版本。该参数的取值是`2021-06-01`。

请求参数

下方表格中参数的类型是请求正文参数。

参数名称	参数类型	是否必选	参数说明	示例
tag	String	否	为证书设置一个标签。允许使用任意字符，无长度限制。	import
project	String	否	设置证书所属的项目。项目是火山引擎提供的一种资源管理工具。您可以使用项目对云资源进行分组，然后基于项目设置访问控制策略或查询账单。更多信息，请参见项目概述。如果您不设置该参数，那么证书将归属到`default`（默认项目）。	default
no_verify_and_fix_chain	Boolean	否	是否跳过证书合法性校验。该参数有以下取值： `false`（默认）：表示不跳过证书合法性校验。证书中心默认对您上传的证书进行合法性校验，如检查证书链是否完整、证书的上下级签发关系是否成立、是否采用了不安全的摘要算法。只有通过合法性校验的证书才允许上传和使用。 `true`：表示跳过证书合法性校验。如果您将该参数值设置为`true`，则证书中心将不会对上传证书的合法性进行校验。只要证书可以正确解析、证书的公钥和私钥相互匹配，就可以上传到证书中心进行使用。跳过合法性校验可能导致您上传并使用有安全风险的证书，从而影响您的线上业务。正常情况下您无需设置该参数。如果需要把该参数值设置为`true`，请务必先咨询证书中心技术团队，我们将帮助您分析业务可能受到的影响。	false
repeatable	Boolean	否	是否允许上传相同的证书。该参数有以下取值： `false`（默认）：表示不允许上传相同的证书。证书中心会检验您上传的证书是否与证书中心已有的证书相同（基于证书指纹进行判断）。如果证书中心已存在相同的证书，那么您的证书无法上传成功，接口将返回与您的证书相同的证书的ID。（如果证书中心存在多本相同证书，则返回的是首本证书的ID。） `true`：表示允许上传相同的证书。如果您将该参数值设置为`true`，那么即使证书中心已存在相同的证书，您仍然可以上传相同的证书。	false
certificate_info	Object	否	要上传的SSL证书（非国密证书）的详情。如果证书采用的RSA或ECC密钥算法，您需要设置该参数，无需设置`gm_certificate_info`参数。
gm_certificate_info	Object	否	要上传的SSL证书（国密证书）的详情。如果证书采用的SM2密钥算法，您需要设置该参数，无需设置`certificate_info`参数。

响应正文

参数名称	参数类型	参数说明	示例
Result	Object	本次请求的返回结果。

示例

请求示例

POST https://open.volcengineapi.com/?Action=ImportCertificate&Version=2021-06-01&<其他公共请求参数>
{
    "tag": "import",
    "project": "default",
    "no_verify_and_fix_chain": false,
    "repeatable": false,
    "certificate_info": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIErjC**********rFYV\nfbAZ2V7v3gVwcw06LrGvzrsLVdG00zB9iSvMyrXNo7e8cl2QLCozcaA9wOCTrAWe\nE03usBCHdK2KBhgeCU6zjil6kYV3yF49rd/1ElYpuXo+gYWNQhVb2HeUVO7ekcbd\nokwkZLngYueE1pHiE4pkbnCw9zh4WBy3Vgw5KwcY9GjDF+XvFRtBvIfVH1f9inQw\n/p/XZ2Waci8B+n3KOdffm0bKpe8spyTxhkhCHhvCEq/pkNGKgQr278j0tMLrJwuC\ndZfjnghVeEBDlcqPKwx9t7JyszhrOXqo4p4K9TvF9oyZzDTNIMbLcW9pVzr5CqNU\nQqQ=\n-----END CERTIFICATE-----\n",
        "private_key": "-----BEGIN RSA PRIVATE KEY-----\n*********XuZlGHLiVTsU7TnD4fPD2blRuV40/SPuZPjpq6up0SBVb/+Ug94Y2WwwPy6qPFdSGhz/8+32y1k5tIZ\nIIkC6fcxVeRDSjO/QxlBKhWPE8z6A4tKD0UkOUECgYAStuO14Sqk6J9abZEbPE0M\n4caUYbtJUpmLRd2IliD8FCM7eUpJoVMFUct2s2ciOHdvD7g7ZfThN9AN9Pi7CzJA\nBxiwIQ/fGxCzpjPNDQjJyXvyhgrgNb4uLlcrmPvj8UuuKcLyKMm1HQs/GR8YgKIt\nhWR3OCIKe1N9a+WWXcdwkQKBgQDCL+UIdWCdtZiBOloXmmH/Knjv9NMBahrhJb4q\nG6EAWfQ0SdGwU3AiFgLwAgTIav1k1xJJsA5+gFGKak0eyNnIpkRmA2hcVuBBQ3J6\nyLy5Wr3ceyc0fNS5KleimQsbksBtRugaxDSkHxLaQWSLCKE9IETS8OMe3hUZ5vm9\nd8lHwQKBgHz0B2BvM6g3oIkaiefMMxo79/BOw/ES9QaVX7RB+TgkfuS9v1kBpKjq\nXd2MDOyOPgcK4FimJijCrqjmiE2T6IuwF6gQ+HqFteTYY7wEHdw0HDtTQWDCrAxk\nhBcj7skQSMZYSTTtnQQZYcF4iUP4+thWLbVHhahefLJMZAnLAl53\n-----END RSA PRIVATE KEY-----\n"
    }
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231222154036CF014DA31777AA08FEEB",
        "Action": "ImportCertificate",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": {
        "id": "cert-3e5ddb7aae7646b5a4235234962aeacd",
        "repeat_id": ""
    }
}

错误代码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。关于更多错误码的信息，参见错误码说明。