全部產品
Search
文件中心

:ImportKeyMaterial

更新時間:Jan 22, 2025

調用ImportKeyMaterial介面匯入密鑰材料。

調用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程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String ImportKeyMaterial

要執行的操作,取值:ImportKeyMaterial

EncryptedKeyMaterial String bCPZx7I6v6KXsqEpr2OXKxuj2CCRtKdwp75Bw+BGncYqBdfjFBYRtOE6HRlT0oeiRDWzwnw9OA54OL36smDJrq4Lo9x0CyYDiuKnRkcKtMtlzW0din7Pd7IlZWWRdVueiw2qpzl7PkUWQGTdsdbzpfJJQ+qj/cRIrk/E83UGyeyytSpgnb+lu0xEYcPajRyWNsbi98N3pqqQzHXNNHO2NJqHlnQgglqTiBEjkGeKFhfKmTc3vjulIdVa3EaVIN6lwWfgx+UUYSrvbA77WDYKlDsZ4SbK2/T7za9Tp1qU7Ynqba7OKGVVj7PMbiaO80AxWZnjUMYCgEp5w7V+seOXqw==

使用GetParametersForImport返回的公開金鑰加密並用base64編碼後的密鑰材料。

ImportToken String Base64String

通過調用GetParametersForImport獲得的匯入令牌。

KeyId String 1234abcd-12ab-34cd-56ef-12345678****

待匯入的主要金鑰ID。

KeyMaterialExpireUnix Long 0

密鑰材料到期時間。

不指定該參數或取值為0,表示密鑰材料不會到期。

說明 取值不可早於調用該API的時間(以伺服器時間為準)。

返回資料

名稱 類型 樣本值 描述
RequestId String ec1017cf-ead4-f3ca-babc-c3b34f3dbecb

請求ID。

樣本

請求樣本

https://[Endpoint]/?Action=ImportKeyMaterial
&EncryptedKeyMaterial=bCPZx7I6v6KXsqEpr2OXKxuj2CCRtKdwp75Bw+BGncYqBdfjFBYRtOE6HRlT0oeiRDWzwnw9OA54OL36smDJrq4Lo9x0CyYDiuKnRkcKtMtlzW0din7Pd7IlZWWRdVueiw2qpzl7PkUWQGTdsdbzpfJJQ+qj/cRIrk/E83UGyeyytSpgnb+lu0xEYcPajRyWNsbi98N3pqqQzHXNNHO2NJqHlnQgglqTiBEjkGeKFhfKmTc3vjulIdVa3EaVIN6lwWfgx+UUYSrvbA77WDYKlDsZ4SbK2/T7za9Tp1qU7Ynqba7OKGVVj7PMbiaO80AxWZnjUMYCgEp5w7V+seOXqw==
&ImportToken=Base64String
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&KeyMaterialExpireUnix=0
&<公用請求參數>

正常返回樣本

XML 格式

<KMS>
    <RequestId>ec1017cf-ead4-f3ca-babc-c3b34f3dbecb</RequestId>
</KMS>

JSON 格式

{
        "RequestId":"ec1017cf-ead4-f3ca-babc-c3b34f3dbecb"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。