ImportKeyMaterial - 导入密钥材料

导入密钥材料。

接口说明

  • 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代码示例。

    授权信息

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

    请求参数

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

    待导入的主密钥 ID。

    1234abcd-12ab-34cd-56ef-12345678****
    EncryptedKeyMaterialstring

    使用 GetParametersForImport 返回的公钥加密并用 base64 编码后的密钥材料。

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

    通过调用 GetParametersForImport 获得的导入令牌。

    Base64String
    KeyMaterialExpireUnixlong

    密钥材料过期时间。
    不指定该参数或取值为 0,表示密钥材料不会过期。

    说明 取值不可早于调用该 API 的时间(以服务器时间为准)。
    0

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    ec1017cf-ead4-f3ca-babc-c3b34f3dbecb

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400InvalidKeyMaterialkey material is invalid-
    400InvalidImportTokenimport token is invalid-
    400ExpiredImportTokenimport token is expired-
    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.-

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