上传证书（已废弃）--证书中心-火山引擎

文档中心

导航

上传证书（已废弃）

最近更新时间：2024.06.24 20:30:01首次发布时间：2022.03.16 16:35:32

调用本接口向证书中心上传一本SSL证书。

注意

本接口已经废弃，虽然现在仍可调用，但可能不再接受更新或者支持。我们不建议您使用本接口。
证书中心提供了一个新的上传证书接口：ImportCertificate。ImportCertificate接口支持更多的设置选项，例如允许您上传重复的证书。强烈推荐您使用ImportCertificate接口来上传证书。

注意事项

请求频率：同一个租户每秒最多允许请求20次。
并发限制：同一个租户在同一时间只允许请求一次。

请求说明

接口名称：CertificateAddInstanceCertificate
请求方式：POST
请求地址：open.volcengineapi.com

调试

暂不支持。

请求参数

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

参数	类型	是否必选	描述	示例值
Region	string	是	服务地区。该参数的取值是`cn-north-1`。	`cn-north-1`
ServiceName	string	是	服务名称。该参数的取值是`certificate_service`。	`certificate_service`

Query

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

参数	类型	是否必选	描述	示例值
Action	string	是	API名称。该参数的取值是`CertificateAddInstanceCertificate`。	`CertificateAddInstanceCertificate`
Version	string	是	API版本。该参数的取值是`2021-06-01`。	`2021-06-01`

Body

下方表格中的参数包含在请求体（request body）中。

参数	类型	是否必选	描述	示例值
chain_id	String	否	如果您希望上传的证书与证书中心已有的证书处于同一个证书关系链，您可以将该参数设置为已有证书的证书关系链 ID。您可以调用 CertificateGetInstance 查询已有证书的证书关系链 ID。	`cert-6c2d6f3c4e0747549d12d875cf2f****`
tag	String	否	为证书设置一个标签。允许使用任意字符，无长度限制。	`上传证书`
purpose	String	是	设置证书的用途。该参数的取值是`ssl`。	`ssl`
type	String	否	设置证书的类型。该参数有以下取值： `dv`：域名验证 `ov`：组织验证 `ev`：扩展验证	`dv`
is_sm	Boolean	否	证书是否为国密证书。该参数有以下取值： `true`：是 `false`（默认）：否	`false`
user_defined_chain	Boolean	否	是否跳过证书合法性校验。该参数有以下取值： `false`（默认）：否，不跳过证书合法性校验。证书中心默认对您上传的证书进行合法性校验，如检查证书链是否完整、证书的上下级签发关系是否成立、是否采用了不安全的摘要算法。只有通过合法性校验的证书才允许上传和使用。 `true`：是，跳过证书合法性校验。如果您将该参数值设置为`true`，则证书中心将不会对上传证书的合法性进行校验。只要证书可以正确解析、证书的公钥和私钥相互匹配，就可以上传到证书中心进行使用。跳过合法性校验可能导致您上传并使用有安全风险的证书，从而影响您的线上业务。正常情况下您无需设置该参数。如果需要把该参数值设置为`true`，请务必先咨询证书中心技术团队，我们将帮助您分析业务可能受到的影响。	`false`
ssl	Object	是	要上传的SSL证书的详情。

返回参数

参数	类型	描述	示例值
Result	String	证书中心为该证书生成的实例ID。	`cert-d51b11c79f2149bf9b8e65e8b7c1****`

请求示例

POST https://open.volcengineapi.com/?Action=CertificateAddInstanceCertificate&Version=2021-06-01&<其他公共请求参数>
{
   "tag":"上传证书",
   "purpose":"ssl",
   "ssl":{
      "certificate":{
         "private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIE......kt4=\n-----END RSA PRIVATE KEY-----\n",
         "chain":[
            "-----BEGIN CERTIFICATE-----\nMIIE......CA==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIE......lg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIID......bd4=\n-----END CERTIFICATE-----\n"
         ]
      }
   }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023011818525862987CA4D7FB7503D0F7",
        "Action": "CertificateAddInstanceCertificate",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": "cert-6e2ce9d68e454ba4b258d62e5450****"
}

错误码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心