更新时间:2022-05-18 GMT+08:00
分享

导出证书

功能介绍

导出证书。

  • 选择是否压缩时,分以下两种情况:

    • 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(证书)。

    • is_compressed为false时,返回json格式,返回的具体参数如下:

      • type = "APACHE"或"NGINX"或"OTHER"时,返回参数如下:

        • certificate(证书内容,PEM格式);

        • certificate_chain(证书链,PEM格式);

        • private_key(证书私钥,PEM格式);

      • type = "IIS"或"TOMCAT"时,暂时未定义。

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

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

certificate_id

String

所要导出的私有证书ID。

最小长度:36

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token,参见:IAM token获取方法

表3 请求Body参数

参数

是否必选

参数类型

描述

is_compressed

String

是否压缩。

  • true

  • false

type

String

根据服务器类型选择下载证书的形式,支持以下五种类型:

  • APACHE : apache服务器推荐使用此参数;

  • NGINX : nginx服务器推荐使用此参数;

  • IIS : windows服务器推荐使用此参数;

  • TOMCAT : tomcat服务器推荐使用此参数;

  • OTHER : 下载PEM格式证书,推荐使用此参数。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

private_key

String

私钥内容。

certificate

String

证书内容。

certificate_chain

String

证书链内容。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

请求示例

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

POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/export

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

响应示例

状态码: 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"
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误。

401

被请求的页面需要鉴权。

403

认证失败。

404

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

500

服务内部错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close