导出证书

功能介绍

导出证书。

• 国际算法
  • 选择是否压缩时，分以下两种情况：
    • is_compressed为true时，返回文件压缩包，命名为：证书名称_type字段小写字母.zip，如”test_apache.zip“。
      • 系统生成密钥签发证书
        • type = "APACHE"时，压缩包中包含三个文件：server.key（密钥文件，内容为PEM格式，若导出证书时设置密码，则为加密后的私钥）、chain.crt（证书链，内容为PEM格式）、server.crt（证书，内容为PEM格式）；
        • type = "IIS"时，压缩包中包含两个文件：keystorePass.txt（keystore口令，若导出证书时设置密码，则无此密码文件）、server.pfx（PFX证书，证书与证书链包含在同一个文件）；
        • type = "NGINX"时，压缩包中包含两个文件：server.key（密钥文件，内容为PEM格式，若导出证书时设置密码，则为加密后的私钥）、server.crt（内容为PEM格式，证书与证书链包含在同一个文件）；
        • type = "TOMCAT"时，压缩包中包含两个文件：keystorePass.txt（keystore口令，若导出证书时设置密码，则无此密码文件）、server.jks（JKX证书，证书与证书链包含在同一个文件）；
        • type = "OTHER"时，压缩包中包含三个文件：server.key（密钥文件，内容为PEM格式，若导出证书时设置密码，则为加密后的私钥）、chain.pem（证书链）、server.pem（证书）。
      • 导入CSR签发证书
        • type = "APACHE"或"IIS"或"TOMCAT"时，压缩包中包含两个文件：chain.crt（证书链，内容为PEM格式）、server.crt（证书，内容为PEM格式）；
        • type = "NGINX"时，压缩包中包含一个文件：server.crt（证书，内容为PEM格式）；
        • type = "OTHER"时，压缩包中包含两个文件：chain.pem（证书链，内容为PEM格式）、cert.pem（证书，内容为PEM格式）。
    • is_compressed为false时，返回json格式，返回的具体参数如下：
      • 系统生成密钥签发证书
        • type = "APACHE"或"NGINX"或"OTHER"时，返回参数如下：
          • certificate（证书内容，PEM格式）；
          • certificate_chain（证书链，PEM格式）；
          • private_key（证书私钥，PEM格式，若导出证书时设置密码，则为加密后的私钥）；
        • type = "IIS"或"TOMCAT"时，暂时未定义。
      • 导入CSR签发证书
        • type = "APACHE"或"NGINX"或"IIS"或"TOMCAT"或"OTHER"时，返回参数如下：
          • certificate（证书内容，PEM格式）；
          • certificate_chain（证书链，PEM格式）；
• 国密算法
  • 选择是否压缩和是否国密标准时，分以下四种情况：
    • is_compressed为true、is_sm_standard为true时，返回文件压缩包，命名为：证书名称_type字段小写字母.zip，如”test_apache.zip“。
      • 系统生成密钥签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，压缩包中包含五个文件：chain.pem（证书链，内容为PEM格式）、signCert.key（签名证书密钥文件，内容为PEM格式，若导出证书时设置密码，则为加密后的私钥）、signCert.pem（签名证书，内容为PEM格式）、encSm2EnvelopedKey.key（加密证书的国密GMT0009标准规范数字信封文件，内容为BASE64编码）、signedAndEnvelopedData.key（加密证书的国密GMT0010标准规范数字信封文件，内容为BASE64编码）、encCert.pem（加密证书，内容为PEM格式）。
      • 导入CSR签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，压缩包中包含四个文件：chain.pem（证书链，内容为PEM格式）、signCert.pem（签名证书，内容为PEM格式）、encSm2EnvelopedKey.key（加密证书的国密GMT0009标准规范数字信封文件，内容为BASE64编码）、signedAndEnvelopedData.key（加密证书的国密GMT0010标准规范数字信封文件，内容为BASE64编码）、encCert.pem（加密证书，内容为PEM格式）。
    • is_compressed为true、is_sm_standard为false时，返回文件压缩包，命名为：证书名称_type字段小写字母.zip，如”test_apache.zip“。
      • 系统生成密钥签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，压缩包中包含五个文件：chain.pem（证书链，内容为PEM格式）、signCert.key（签名证书密钥文件，内容为PEM格式，若导出证书时设置密码，则为加密后的私钥）、signCert.pem（签名证书，内容为PEM格式）、encCert.key（加密证书密钥文件，内容为PEM格式，若导出证书时设置密码，则为加密后的私钥）、encCert.pem（加密证书，内容为PEM格式）。
      • 导入CSR签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，压缩包中包含四个文件：chain.pem（证书链，内容为PEM格式）、signCert.pem（签名证书，内容为PEM格式）、encCert.key（加密证书密钥文件，内容为PEM格式）、encCert.pem（加密证书，内容为PEM格式）。
    • is_compressed为false、is_sm_standard为true时，返回json格式，返回的具体参数如下：
      • 系统生成密钥签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，返回参数如下：
          • certificate_chain（证书链，PEM格式）；
          • certificate（签名证书内容，PEM格式）；
          • private_key（签名证书私钥，PEM格式，若导出证书时设置密码，则为加密后的私钥）；
          • enc_certificate（加密证书内容，PEM格式）；
          • enc_sm2_enveloped_key（加密证书的国密GMT0009标准规范数字信封文件，BASE64编码）；
          • signed_and_enveloped_data（加密证书的国密GMT0010标准规范数字信封文件，BASE64编码）。
      • 导入CSR签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，返回参数如下：
          • certificate_chain（证书链，PEM格式）；
          • certificate（签名证书内容，PEM格式）；
          • enc_certificate（加密证书内容，PEM格式）；
          • enc_sm2_enveloped_key（加密证书的国密GMT0009标准规范数字信封文件，BASE64编码）；
          • signed_and_enveloped_data（加密证书的国密GMT0010标准规范数字信封文件，BASE64编码）。
    • is_compressed为false、is_sm_standard为false时，返回json格式，返回的具体参数如下：
      • 系统生成密钥签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，返回参数如下：
          • certificate_chain（证书链，PEM格式）；
          • certificate（签名证书内容，PEM格式）；
          • private_key（签名证书私钥，PEM格式，若导出证书时设置密码，则为加密后的私钥）；
          • enc_certificate（加密证书内容，PEM格式）；
          • enc_private_key（加密证书私钥，PEM格式，若导出证书时设置密码，则为加密后的私钥）。
      • 导入CSR签发证书
        • type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时，暂时未定义；
        • type = "OTHER"时，返回参数如下：
          • certificate_chain（证书链，PEM格式）；
          • certificate（签名证书内容，PEM格式）；
          • enc_certificate（加密证书内容，PEM格式）；
          • enc_private_key（加密证书私钥，PEM格式）。

只有当证书状态为“已签发”时，可进行导出操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/private-certificates/{certificate_id}/export

请求参数

响应参数

状态码： 200

状态码： 400

状态码： 401

状态码： 403

状态码： 404

状态码： 500

请求示例

导出证书，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。

POST https://{Endpoint}/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/export

{
  "type" : "other",
  "is_compressed" : false,
  "password" : "test"
}

响应示例

状态码： 200

请求已成功

{
  "certificate" : "-----BEGIN CERTIFICATE-----\r\n******\r\n-----END CERTIFICATE-----",
  "certificate_chain" : "-----BEGIN CERTIFICATE-----\r\n******\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\n******\r\n-----END CERTIFICATE-----",
  "private_key" : "-----BEGIN RSA PRIVATE KEY-----\r\n******\r\n-----END RSA PRIVATE KEY-----\r\n"
}

状态码： 400

请求参数有误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 401

被请求的页面需要鉴权。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 403

认证失败。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 404

资源不存在或资源未找到。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 500

服务内部错误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码

错误码

请参见错误码。