GetParametersForImport - 获取导入主密钥(CMK)材料的参数

获取导入主密钥材料的参数。

接口说明

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

  • 返回的参数可用于执行 ImportKeyMaterial

  • 主密钥材料来源必须是外部,即 Origin 为 EXTERNAL。

  • 本次调用返回的公钥和令牌必须搭配使用,且只能用于本次调用中指定的主密钥。

  • 每次调用返回的公钥与令牌都不相同。

  • 您需要指定用于加密密钥材料的公钥类型和加密算法,对应关系如下表所示。

    公钥类型加密算法说明
    RSA_2048RSAES_PKCS1_V1_5
    RSAES_OAEP_SHA_1
    RSAES_OAEP_SHA_256
    支持所有地域、任意保护级别的密钥。
    专属 KMS 不支持 RSAES_OAEP_SHA_1。
    EC_SM2SM2PKESM2 为中国国家密码管理局批准的密码算法,仅支持导入保护级别为 HSM 的密钥,KMS 通过部署在中国内地的托管密码机提供支持。更多信息,请参见托管密码机简介

    更多信息,请参见导入密钥材料。本文将提供一个示例,获取密钥 ID 为1234abcd-12ab-34cd-56ef-12345678****、加密算法为RSAES_PKCS1_V1_5、公钥类型为RSA_2048的主密钥材料参数,返回的主密钥材料参数包含密钥 ID、用于加密密钥材料的公钥(PublicKey)、导入密钥材料的令牌(ImportToken)以及令牌的过期时间。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
KeyIdstring

主密钥的全局唯一标识符。

说明 密钥材料来源必须是外部,即 Origin 为 EXTERNAL。
202b9877-5a25-46e3-a763-e20791b5****
WrappingAlgorithmstring

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

RSAES_PKCS1_V1_5
WrappingKeySpecstring

用于加密密钥材料的公钥类型。

RSA_2048

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
KeyIdstring

主密钥全局唯一标识符。
后续调用 ImportKeyMaterial 时需要指定该参数。

202b9877-5a25-46e3-a763-e20791b5****
ImportTokenstring

导入令牌。
令牌的有效期为 24 小时。后续调用 ImportKeyMaterial 时需要指定该参数。

Base64String
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc
TokenExpireTimestring

导入令牌的过期时间。

2018-01-25T00:01:02Z
PublicKeystring

用于加密密钥材料的公钥。
采用 Base64 编码。

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错误码错误信息描述
400Unsupported.OriginThis key origin is not valid for this api此密钥来源不支持该API调用。
400InvalidParameterThe specified parameter is not valid.参数非法。
404InvalidAccessKeyId.NotFoundThe Access Key ID provided does not exist in our records.-

访问错误中心查看更多错误码。