ImportKeyMaterial_密钥管理服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

调用 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 解密。
  • 流控信息

    当前云产品API请求速率暂未透出。

    授权信息

    当前云产品暂无权限信息透出。

    请求参数

    字段名称字段详情
    KeyIdstring

    待导入的主密钥 ID。

    示例值:1234abcd-12ab-34cd-56ef-12345678****参考取值来源:
      ListKeys
      CreateKey
    EncryptedKeyMaterialstring

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

    示例值:bCPZx7I6v6KXsqEpr2OXKxuj2CCRtKdwp75Bw+BGncYqBdfjFBYRtOE6HRlT0oeiRDWzwnw9OA54OL36smDJrq4Lo9x0CyYDiuKnRkcKtMtlzW0din7Pd7IlZWWRdVueiw2qpzl7PkUWQGTdsdbzpfJJQ+qj/cRIrk/E83UGyeyytSpgnb+lu0xEYcPajRyWNsbi98N3pqqQzHXNNHO2NJqHlnQgglqTiBEjkGeKFhfKmTc3vjulIdVa3EaVIN6lwWfgx+UUYSrvbA77WDYKlDsZ4SbK2/T7za9Tp1qU7Ynqba7OKGVVj7PMbiaO80AxWZnjUMYCgEp5w7V+seOXqw==
    ImportTokenstring

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

    示例值:Base64String
    KeyMaterialExpireUnixinteger<int64>

    密钥材料过期时间。 展开详情

    注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
    示例值:0

    返回参数

    字段名称字段详情
    RequestIdstring

    请求 ID。

    示例值:ec1017cf-ead4-f3ca-babc-c3b34f3dbecb

    错误码

    全局错误码
    HTTP 状态码错误码错误信息操作
    400
    InvalidKeyMaterial
    key material is invalid诊断
    400
    InvalidImportToken
    import token is invalid诊断
    400
    ExpiredImportToken
    import token is expired诊断
    400
    Unsupported.Origin
    This key origin is not valid for this api诊断
    400
    InvalidParameter
    The specified parameter is not valid.诊断
    404
    InvalidAccessKeyId.NotFound
    The Access Key ID provided does not exist in our records.诊断

    变更历史

    变更时间变更内容概要操作
    2022-09-22
    变更错误码400
    新增错误码404

    相关示例

    通过调用 ImportKeyMaterial 接口导入密钥材料示例
    2023-03-29