本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。
获取单个客户端证书或服务端证书的私钥(加密格式)。
接口说明
本接口只适用基于系统生成的 CSR(Certificate Signing Request)签发的证书,用于获取客户端证书或服务端证书的私钥(加密格式)。调用本接口前,您必须已经调用以下接口签发了客户端证书或服务端证书:
为确保私钥传输安全,本接口会使用您设置的私钥密码(一个加密字符串)为私钥加密,并返回加密后的私钥。您获取证书私钥(加密格式)后,可以通过以下方法为私钥解密:
证书的加密算法为 RSA 时,您需要在安装了 OpenSSL 或 BabaSSL 的计算机上执行
openssl rsa -in <加密的私钥文件> -passin pass:<私钥密码> -out <解密的私钥文件>命令来解密私钥。证书的加密算法为 ECC 时,您需要在安装了 OpenSSL 或 BabaSSL 的计算机上执行
openssl ec -in <加密的私钥文件> -passin pass:<私钥密码> -out <解密的私钥文件>命令来解密私钥。证书的加密算法为 SM2 时,您需要在安装了 BabaSSL 的计算机上执行
openssl ec -in <加密的私钥文件> -passin pass:<私钥密码> -out <解密的私钥文件>命令来解密私钥。
您可以调用 DescribeClientCertificate 查询客户端证书或服务端证书的加密算法类型。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-cert:DescribeCertificatePrivateKey |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Identifier |
string |
是 |
要获取私钥的客户端证书或服务端证书的唯一识别码。 说明
您可以调用 ListClientCertificate 查询所有客户端与服务端证书的唯一识别码。 |
bc37133bb7ed68c7938d928fd26d**** |
| EncryptedCode |
string |
是 |
设置用于加密私钥的密码。支持使用英文大小写字母、数字、特殊字符(例如, 警告 请记住您设置的密码,后续您需要使用该密码为私钥(加密格式)解密。如果您忘记了已设置的私钥密码,则本次调用获取的私钥(加密格式)将无法解密,您必须重新调用本接口。
|
!QA@WS3ed |
| ResourceGroupId |
string |
否 |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。
调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
GetCertificatePrivateKeyResponse。 |
||
| EncryptedData |
string |
加密后的私钥内容。 |
-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY----- |
| RequestId |
string |
本次请求的 ID。 |
09470F19-CEE8-5C63-BF2C-02B5E3F07A17 |
示例
正常返回示例
JSON格式
{
"EncryptedData": "-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----",
"RequestId": "09470F19-CEE8-5C63-BF2C-02B5E3F07A17"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。