1. 接口描述
接口请求域名: kms.api3.fincloud.tencent.com。
用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。
只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。
默认接口请求频率限制:10次/秒。
接口更新时间:2020-08-11 12:02:05。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:ImportKeyMaterial |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-18 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| EncryptedKeyMaterial | 是 | 否 | String | 使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。 示例值: YLbjnjPPIYjPb1XhyBYNmcr7yv1YMnfDmuHX8D0qCmUAP3Qi+2URkLJvZ/zCWuJK0Y23/QHX8a8lrKz4WVgUVuoleOriQMNx+AcRkjCegkcqkdJ8BNlaXsNJ67zjSZWDu9qI+bHXEqSIcXcz/l5jdBEum6tYViIDrNKIY6FaLC0Ex7y3eoN5A3YFhQoL7F7upNXZHhogP+YXqLqD7fKzsM8qgMW25qSddlhW4H1s1zOfwfobLAQDXofu9OAZ58Xf8KjnqEoA1Bn60kuJBoqqUV4BqOG3egTqCQaCdcn98oZFPTQpB/SVCE4hENncEV3tNihv2IwjFxSCjZHcJzhYuQ== |
| ImportToken | 是 | 否 | String | 通过调用GetParametersForImport获得的导入令牌。 示例值: +b1d61DykcbWNoKUIjj+OQA5M+Iu5BiXfxldNy/wDbZL31mB2+SAA29TZgXBKYXbCts9ULktWZxU6X81O4jRrvmKwKET2gEg4A6koZrJW+KMAzqTazyWtP464EV4/6Gp |
| ValidTo | 否 | 否 | Uint64 | 密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。 示例值: 0 |
| KeyId | 是 | 否 | String | 指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。 示例值: 93866e69-9755-11ef-8e65-52540089bc41 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| ResourceUnavailable.CmkNotFound | CMK不存在。 |
| InternalError | 内部错误。 |
| UnsupportedOperation.NotExternalCmk | CMK类型错误,仅支持External CMK。 |
| ResourceUnavailable.CmkStateNotSupport | CMK 状态不支持该操作。 |
| ResourceUnavailable.TokenExpired | Token已过期。 |
| InvalidParameter.DecryptMaterialError | 解密EncryptedKeyMaterial失败。 |
| InvalidParameterValue.MaterialNotMatch | 导入的密钥材料和历史导入不同。 |
| UnsupportedOperation.ServiceTemporaryUnavailable | 服务暂时不可用。 |