匯入密鑰材料。
介面說明
-
RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
-
調用 CreateKey 建立主要金鑰時，可以選擇其密鑰材料來源為外部，即將 Origin 設定為 EXTERNAL。此 API 用於將密鑰材料匯入符合上述描述的 CMK 中。
-
要查看 CMK 的 Origin，請參見 DescribeKey 。
-
在匯入密鑰材料之前， 需要調用 GetParametersForImport 先獲得匯入密鑰材料需要的參數，即用於加密金鑰材料的公開金鑰（PublicKey）和匯入令牌（ImportToken）。
對密鑰類型為Aliyun_AES_256的 CMK，密鑰材料必須為 256 位；對密鑰類型為Aliyun_SM4的 CMK，密鑰材料必須為 128 位。
您可以為密鑰材料設定到期時間，也可以設定其永不到期。
您可以隨時為指定的 CMK 重新匯入密鑰材料，並重新指定到期時間，但必須匯入相同的密鑰材料。
匯入的密鑰材料到期或者被刪除後，指定的 CMK 將無法使用，需要再次匯入相同的密鑰材料才可正常使用。
同樣的密鑰材料可匯入不同的 CMK 中，但使用其中一個 CMK 加密的資料或產生的資料密鑰（Data Key）無法使用另一個 CMK 解密。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
待匯入的主要金鑰 ID。 |
1234abcd-12ab-34cd-56ef-12345678**** |
| EncryptedKeyMaterial |
string |
是 |
使用 GetParametersForImport 返回的公開金鑰加密並用 base64 編碼後的密鑰材料。 |
bCPZx7I6v6KXsqEpr2OXKxuj2CCRtKdwp75Bw+BGncYqBdfjFBYRtOE6HRlT0oeiRDWzwnw9OA54OL36smDJrq4Lo9x0CyYDiuKnRkcKtMtlzW0din7Pd7IlZWWRdVueiw2qpzl7PkUWQGTdsdbzpfJJQ+qj/cRIrk/E83UGyeyytSpgnb+lu0xEYcPajRyWNsbi98N3pqqQzHXNNHO2NJqHlnQgglqTiBEjkGeKFhfKmTc3vjulIdVa3EaVIN6lwWfgx+UUYSrvbA77WDYKlDsZ4SbK2/T7za9Tp1qU7Ynqba7OKGVVj7PMbiaO80AxWZnjUMYCgEp5w7V+seOXqw== |
| ImportToken |
string |
是 |
通過調用 GetParametersForImport 獲得的匯入令牌。 |
Base64String |
| KeyMaterialExpireUnix |
integer |
是 |
密鑰材料到期時間。 說明
取值不可早於調用該 API 的時間（以伺服器時間為準）。 |
0 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
ec1017cf-ead4-f3ca-babc-c3b34f3dbecb |
樣本
正常返回樣本
JSON格式
{
"RequestId": "ec1017cf-ead4-f3ca-babc-c3b34f3dbecb"
}異常返回樣本
JSON格式
//xml response
ec1017cf-ead4-f3ca-babc-c3b34f3dbecb
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidKeyMaterial | key material is invalid | |
| 400 | InvalidImportToken | import token is invalid | |
| 400 | ExpiredImportToken | import token is expired | |
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。