调用DescribeCertificatePrivateKey获取单个客户端证书或服务端证书的私钥(加密格式)。

使用说明

本接口只适用基于系统生成的CSR(Certificate Signing Request)签发的证书,用于获取客户端证书或服务端证书的私钥(加密格式)。调用本接口前,您必须已经调用以下接口签发了客户端证书或服务端证书:

注意 如果您调用CreateCertificateWithExtension接口签发证书,请不要设置CsrPemString参数,否则签发的证书基于自定义的CSR,不支持通过本接口获取私钥。

为确保私钥传输安全,本接口会使用您设置的私钥密码(一个加密字符串)为私钥加密,并返回加密后的私钥。您获取证书私钥(加密格式)后,可以通过以下方法为私钥解密:

  • 证书的加密算法为RSA时,您需要在安装了OpenSSLBabaSSL的计算机上执行openssl rsa -in <加密的私钥文件> -passin pass:<私钥密码> -out <解密的私钥文件>命令来解密私钥。
  • 证书的加密算法为ECC时,您需要在安装了OpenSSLBabaSSL的计算机上执行openssl ec -in <加密的私钥文件> -passin pass:<私钥密码> -out <解密的私钥文件>命令来解密私钥。
  • 证书的加密算法为SM2时,您需要在安装了BabaSSL的计算机上执行openssl ec -in <加密的私钥文件> -passin pass:<私钥密码> -out <解密的私钥文件>命令来解密私钥。
说明 您可以调用DescribeClientCertificate查询客户端证书或服务端证书的加密算法类型。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCertificatePrivateKey

要执行的操作。取值:DescribeCertificatePrivateKey

Identifier String bc37133bb7ed68c7938d928fd26d****

要获取私钥的客户端证书或服务端证书的唯一识别码。

说明 您可以调用ListClientCertificate查询所有客户端与服务端证书的唯一识别码。
EncryptedCode String !QA@WS3ed

设置用于加密私钥的密码。支持使用英文大小写字母、数字、特殊字符(例如,,.+-_#)等。最大长度为32字节。

警告 请记住您设置的密码,后续您需要使用该密码为私钥(加密格式)解密。如果您忘记了已设置的私钥密码,则本次调用获取的私钥(加密格式)将无法解密,您必须重新调用本接口。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
EncryptedData String -----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----

加密后的私钥内容。

RequestId String 09470F19-CEE8-5C63-BF2C-02B5E3F07A17

本次请求的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCertificatePrivateKey
&Identifier=bc37133bb7ed68c7938d928fd26d****
&EncryptedCode=!QA@WS3ed
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCertificatePrivateKeyResponse>
    <EncryptedData>-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----</EncryptedData>
    <RequestId>09470F19-CEE8-5C63-BF2C-02B5E3F07A17</RequestId>
</DescribeCertificatePrivateKeyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EncryptedData" : "-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----",
  "RequestId" : "09470F19-CEE8-5C63-BF2C-02B5E3F07A17"
}

错误码

访问错误中心查看更多错误码。