擷取匯入主要金鑰材料的參數。
介面說明
-
RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
-
返回的參數可用於執行 ImportKeyMaterial 。
-
主要金鑰材料來源必須是外部，即 Origin 為 EXTERNAL。
-
本次調用返回的公開金鑰和令牌必須搭配使用，且只能用於本次調用中指定的主要金鑰。
-
每次調用返回的公開金鑰與令牌都不相同。
-
您需要指定用於加密金鑰材料的公開金鑰類型和密碼編譯演算法，對應關係如下表所示。
公開金鑰類型 密碼編譯演算法 說明 RSA_2048 RSAES_PKCS1_V1_5
RSAES_OAEP_SHA_1
RSAES_OAEP_SHA_256支援所有地區、任意保護層級的密鑰。
專屬 KMS 不支援 RSAES_OAEP_SHA_1。EC_SM2 SM2PKE SM2 為中國國家密碼管理局獲批准的密碼演算法，僅支援匯入保護層級為 HSM 的密鑰，KMS 通過部署在中國內地的託管密碼機提供支援。更多資訊，請參見託管密碼機簡介。 更多資訊，請參見匯入密鑰材料。本文將提供一個樣本，擷取金鑰識別碼 為
1234abcd-12ab-34cd-56ef-12345678****、密碼編譯演算法為RSAES_PKCS1_V1_5、公開金鑰類型為RSA_2048的主要金鑰材料參數，返回的主要金鑰材料參數包含金鑰識別碼、用於加密金鑰材料的公開金鑰（PublicKey）、匯入密鑰材料的令牌（ImportToken）以及令牌的到期時間。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
主要金鑰的通用唯一識別碼。 說明
密鑰材料來源必須是外部，即 Origin 為 EXTERNAL。 |
202b9877-5a25-46e3-a763-e20791b5**** |
| WrappingAlgorithm |
string |
是 |
用於加密金鑰材料的演算法。 |
RSAES_PKCS1_V1_5 |
| WrappingKeySpec |
string |
是 |
用於加密金鑰材料的公開金鑰類型。 |
RSA_2048 |
關於公用請求參數的詳情，請參見公用參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| KeyId |
string |
主要金鑰通用唯一識別碼。 |
202b9877-5a25-46e3-a763-e20791b5**** |
| ImportToken |
string |
匯入令牌。 |
Base64String |
| RequestId |
string |
本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。 |
8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc |
| TokenExpireTime |
string |
匯入令牌的到期時間。 |
2018-01-25T00:01:02Z |
| PublicKey |
string |
用於加密金鑰材料的公開金鑰。 |
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID**** |
樣本
正常返回樣本
JSON格式
{
"KeyId": "202b9877-5a25-46e3-a763-e20791b5****",
"ImportToken": "Base64String",
"RequestId": "8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc",
"TokenExpireTime": "2018-01-25T00:01:02Z",
"PublicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Unsupported.Origin | This key origin is not valid for this api | 此密鑰來源不支援該API調用。 |
| 400 | InvalidParameter | The specified parameter is not valid. | 參數非法。 |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。