创建主密钥

最近更新时间:2019-07-04 17:22:02

1. 接口描述

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

创建用户管理数据密钥的主密钥CMK(Custom Master Key)。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateKey
Version String 公共参数,本接口取值:2019-01-18
Region String 公共参数,详见产品支持的 地域列表
Alias String 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合。以 kms- 作为前缀的用于云产品使用,Alias 不可重复。
Description String CMK 的描述,最大1024字节
KeyUsage String 指定key的用途。目前,仅支持"ENCRYPT_DECRYPT",默认为 "ENCRYPT_DECRYPT",即key用于加密和解密
Type Integer 指定key类型,1为当前地域默认类型,默认为1,且当前只支持该类型

3. 输出参数

参数名称 类型 描述
KeyId String CMK的全局唯一标识符
Alias String 作为密钥更容易辨识,更容易被人看懂的别名
CreateTime Integer 密钥创建时间,unix时间戳
Description String CMK的描述
注意:此字段可能返回 null,表示取不到有效值。
KeyState String CMK的状态
KeyUsage String CMK的用途
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建主密钥示例

创建用户管理数据密钥的主密钥CMK(Custom Master Key),通过CMK后续可以调用其他接口诸如创建数据密钥、加解密等操作。

输入示例

https://kms.tencentcloudapi.com/?Action=CreateKey
&Alias=mykey
&KeyUsage=ENCRYPT_DECRYPT
&Description=test
&<公共请求参数>

输出示例

{
  "Response": {
    "KeyId": "9999aed0-4956-11e9-bc70-5254005e86b4",
    "Alias": "alias-0001",
    "CreateTime": 1552897190,
    "Description": "test cmk",
    "KeyState": "Enabled",
    "KeyUsage": "ENCRYPT_DECRYPT",
    "RequestId": "850bf779-2249-4995-8c55-b3966daf0a8c"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.AliasAlreadyExists 别名已经存在。
InvalidParameterValue.InvalidAlias 别名格式错误。
InvalidParameterValue.InvalidKeyUsage KeyUsage参数错误。
InvalidParameterValue.InvalidType Type参数错误。
LimitExceeded.CmkLimitExceeded CMK数量已达上限。
UnauthorizedOperation 未授权操作。