GetParametersForImport_密钥管理服务_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.

接口说明

使用说明

  • 返回的参数可用于执行 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)以及令牌的过期时间。

流控信息

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

授权信息

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

请求参数

字段名称字段详情
KeyIdstring

主密钥的全局唯一标识符。展开详情

示例值:202b9877-5a25-46e3-a763-e20791b5****参考取值来源:
    ListKeys
    CreateKey
WrappingAlgorithmstring

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

示例值:RSAES_PKCS1_V1_5
WrappingKeySpecstring

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

示例值:RSA_2048

请求说明

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

返回参数

字段名称字段详情
KeyIdstring

主密钥全局唯一标识符。 展开详情

示例值:202b9877-5a25-46e3-a763-e20791b5****
ImportTokenstring

导入令牌。 展开详情

示例值:Base64String
RequestIdstring

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

示例值:8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc
TokenExpireTimestring

导入令牌的过期时间。

示例值:2018-01-25T00:01:02Z
PublicKeystring

用于加密密钥材料的公钥。 展开详情

示例值:MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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

相关示例

通过调用 GetParametersForImport 接口获取导入主密钥材料的参数示例
2023-03-29