擷取單個用戶端認證或服務端認證的私密金鑰(加密格式)。
介面說明
本介面只適用基於系統產生的 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 |
是 |
設定用於加密私密金鑰的密碼。支援使用英文大小寫字母、數字、特殊字元(例如, 警告 請記住您設定的密碼,後續您需要使用該密碼為私密金鑰(加密格式)解密。如果您忘記了已設定的私密金鑰密碼,則本次調用擷取的私密金鑰(加密格式)將無法解密,您必須重新調用本介面。
|
!Demo@WS3ed |
| ResourceGroupId |
string |
否 |
認證所屬資源群組的 ID。 |
test |
調用 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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。