文档中心 密钥管理系统 API 文档 密钥相关接口 获取导入主密钥(CMK)材料的参数

获取导入主密钥(CMK)材料的参数

最近更新时间:2019-10-17 19:22:15

1. 接口描述

接口请求域名: kms.tencentcloudapi.com 。

获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。

默认接口请求频率限制:10次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetParametersForImport
Version String 公共参数,本接口取值:2019-01-18
Region String 公共参数,详见产品支持的 地域列表
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 Integer 该导出token和公钥的有效期,超过该时间后无法导入,需要重新调用GetParametersForImport获取。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取导入主密钥(CMK)材料的参数

输入示例

https://kms.tencentcloudapi.com/?Action=GetParametersForImport
&KeyId=1ff78c0d-c54b-11e9-9cc9-5254006d0810
&WrappingAlgorithm=RSAES_OAEP_SHA_1
&WrappingKeySpec=RSA_2048
&<公共请求参数>

输出示例

{
  "Response": {
    "KeyId": "1ff78c0d-c54b-11e9-9cc9-5254006d0810",
    "ImportToken": "Sy+GF4f+XxUan1sfSBfqWQmyJeVO30wcqLEMoW4REpw3adjEFXyCP2yqzV8xdD5GMY4gIZoDfJ33SnnbxDMRND8lzh4mZjzFNM8PsjhYrgVSxIiJOCHupZvD4QcoGco8",
    "PublicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1IjpYRubNKn97lPU0/eR8UBaV11glfQLNqlub+YspXwBsvVqcnSvu5c8GoLTEYGSTVbvsREDCq6VfFoSeoIqbv8aWukxbPGWgI1nu55ocvWwthzROFA5UPGC8LOuH0ftZ5Z7cIaigEenS3ngfo4MYTJtg6/Bl1jJVWvjnKzgswsZeFclSURedSXUcMxfSI344s6I17DTNAQ/vQqyjFGIyo2+JctaxVlY2XuBZf7tPimNdoxAoJ14QxAl1gQGu959xnRJ4rwZbxsklJnEivQqTBeFIiv3KTzFJS6bkz2eqRJ1p4jTBDWbHEWTVt6tdXPj4+4D21RFGAt3706vf4PIrwIDAQAB",
    "ParametersValidTo": 1566614716,
    "RequestId": "5e137679-519f-409f-9a99-579a034cc320"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceUnavailable.CmkNotFound CMK不存在。
UnsupportedOperation.NotExternalCmk CMK类型错误,仅支持External CMK。