調(diào)用GetParametersForImport接口獲取導(dǎo)入主密鑰材料的參數(shù)。

使用說明
  • 返回的參數(shù)可用于執(zhí)行ImportKeyMaterial。
  • 主密鑰材料來源必須是外部，即Origin為EXTERNAL。
  • 本次調(diào)用返回的公鑰和令牌必須搭配使用，且只能用于本次調(diào)用中指定的主密鑰。
  • 每次調(diào)用返回的公鑰與令牌都不相同。

  • 您需要指定用于加密密鑰材料的公鑰類型和加密算法，對(duì)應(yīng)關(guān)系如下表所示。

    公鑰類型

    加密算法

    說明

    RSA_2048

    RSAES_PKCS1_V1_5

    RSAES_OAEP_SHA_1

    RSAES_OAEP_SHA_256

    支持所有地域、任意保護(hù)級(jí)別的密鑰。

    專屬KMS不支持RSAES_OAEP_SHA_1。

    EC_SM2

    SM2PKE

    SM2為中國(guó)國(guó)家密碼管理局批準(zhǔn)的密碼算法，僅支持導(dǎo)入保護(hù)級(jí)別為HSM的密鑰，KMS通過部署在中國(guó)內(nèi)地的托管密碼機(jī)提供支持。更多信息，請(qǐng)參見托管密碼機(jī)簡(jiǎn)介。

    更多信息，請(qǐng)參見導(dǎo)入密鑰材料。本文將提供一個(gè)示例，獲取密鑰ID為1234abcd-12ab-34cd-56ef-12345678****、加密算法為RSAES_PKCS1_V1_5、公鑰類型為RSA_2048的主密鑰材料參數(shù)，返回的主密鑰材料參數(shù)包含密鑰ID、用于加密密鑰材料的公鑰（PublicKey）、導(dǎo)入密鑰材料的令牌（ImportToken）以及令牌的過期時(shí)間。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱類型是否必選示例值描述
ActionString是GetParametersForImport

要執(zhí)行的操作。取值：GetParametersForImport。

KeyIdString是202b9877-5a25-46e3-a763-e20791b5****

主密鑰的全局唯一標(biāo)識(shí)符。

說明 密鑰材料來源必須是外部，即Origin為EXTERNAL。
WrappingAlgorithmString是RSAES_PKCS1_V1_5

用于加密密鑰材料的算法。

WrappingKeySpecString是RSA_2048

用于加密密鑰材料的公鑰類型。

關(guān)于公共請(qǐng)求參數(shù)的詳情，請(qǐng)參見公共參數(shù)。

返回?cái)?shù)據(jù)

名稱類型示例值描述
KeyIdString202b9877-5a25-46e3-a763-e20791b5****

主密鑰全局唯一標(biāo)識(shí)符。

后續(xù)調(diào)用ImportKeyMaterial時(shí)需要指定該參數(shù)。

ImportTokenStringBase64String

導(dǎo)入令牌。

令牌的有效期為24小時(shí)。后續(xù)調(diào)用ImportKeyMaterial時(shí)需要指定該參數(shù)。

RequestIdString8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc

本次調(diào)用請(qǐng)求的ID，是由阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符，可用于排查和定位問題。

TokenExpireTimeString2018-01-25T00:01:02Z

導(dǎo)入令牌的過期時(shí)間。

PublicKeyStringMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****

用于加密密鑰材料的公鑰。

采用Base64編碼。

示例

請(qǐng)求示例

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

正常返回示例

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****"
}

錯(cuò)誤碼

HttpCode錯(cuò)誤碼錯(cuò)誤信息描述
400Unsupported.OriginThis key origin is not valid for this api此密鑰來源不支持該API調(diào)用。

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。