GetParametersForImport -

調用GetParametersForImport介面擷取匯入主要金鑰材料的參數。

使用說明

返回的參數可用於執行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通過部署在中國內地的託管密碼機提供支援。更多資訊，請參見託管密碼機簡介。

更多資訊，請參見匯入密鑰材料。本文將提供一個樣本，擷取密鑰ID為1234abcd-12ab-34cd-56ef-12345678****、密碼編譯演算法為RSAES_PKCS1_V1_5、公開金鑰類型為RSA_2048的主要金鑰材料參數，返回的主要金鑰材料參數包含密鑰ID、用於加密金鑰材料的公開金鑰（PublicKey）、匯入密鑰材料的令牌（ImportToken）以及令牌的到期時間。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	GetParametersForImport	要執行的操作。取值：GetParametersForImport。
KeyId	String	是	202b9877-5a25-46e3-a763-e20791b5****	主要金鑰的通用唯一識別碼。說明密鑰材料來源必須是外部，即Origin為EXTERNAL。
WrappingAlgorithm	String	是	RSAES_PKCS1_V1_5	用於加密金鑰材料的演算法。
WrappingKeySpec	String	是	RSA_2048	用於加密金鑰材料的公開金鑰類型。

關於公用請求參數的詳情，請參見公用參數。

返回資料

名稱	類型	樣本值	描述
KeyId	String	202b9877-5a25-46e3-a763-e20791b5****	主要金鑰通用唯一識別碼。後續調用ImportKeyMaterial時需要指定該參數。
ImportToken	String	Base64String	匯入令牌。令牌的有效期間為24小時。後續調用ImportKeyMaterial時需要指定該參數。
RequestId	String	8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc	本次調用請求的ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。
TokenExpireTime	String	2018-01-25T00:01:02Z	匯入令牌的到期時間。
PublicKey	String	MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****	用於加密金鑰材料的公開金鑰。採用Base64編碼。

樣本

請求樣本

http(s)://[Endpoint]/?Action=GetParametersForImport
&KeyId=202b9877-5a25-46e3-a763-e20791b5****
&WrappingAlgorithm=RSAES_PKCS1_V1_5
&WrappingKeySpec=RSA_2048
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetParametersForImportResponse>
    <KeyId>202b9877-5a25-46e3-a763-e20791b5****</KeyId>
    <ImportToken>Base64String</ImportToken>
    <RequestId>8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc</RequestId>
    <TokenExpireTime>2018-01-25T00:01:02Z</TokenExpireTime>
    <PublicKey>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****</PublicKey>
</GetParametersForImportResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****"
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	Unsupported.Origin	This key origin is not valid for this api	此密鑰來源不支援該API調用。

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