获取导入主密钥(CMK)材料的参数
最近更新时间: 2025-02-18 17:50:22
1. 接口描述
接口请求域名: kms.api3.fincloud.tencent.cn。
获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。
默认接口请求频率限制:10次/秒。
接口更新时间:2020-08-11 11:59:37。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:GetParametersForImport |
Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-18 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
KeyId | 是 | 否 | String | CMK的唯一标识,获取密钥参数的CMK必须是EXTERNAL类型,即在CreateKey时指定Type=2 类型的CMK。 |
WrappingAlgorithm | 是 | 否 | String | 指定加密密钥材料的算法,目前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256 |
WrappingKeySpec | 是 | 否 | String | 指定加密密钥材料的类型,目前只支持RSA_2048 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
KeyId | String | CMK的唯一标识,用于指定目标导入密钥材料的CMK。 |
ImportToken | String | 导入密钥材料需要的token,用于作为 ImportKeyMaterial 的参数。 |
PublicKey | String | 用于加密密钥材料的RSA公钥,base64编码。使用PublicKey base64解码后的公钥将导入密钥进行加密后作为 ImportKeyMaterial 的参数。 |
ParametersValidTo | Uint64 | 该导出token和公钥的有效期,超过该时间后无法导入,需要重新调用GetParametersForImport获取。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | |
ResourceUnavailable.CmkNotFound | |
InvalidParameterValue.InvalidKeyId | |
InternalError | |
UnsupportedOperation.NotExternalCmk | |
UnsupportedOperation.ServiceTemporaryUnavailable |