租户端 安全 密钥管理系统（KMS） 密钥相关接口 CreateKey

CreateKey

最近更新时间: 2025-10-20 17:05:53

1. 接口描述

接口请求域名： kms.api3.fincloud.tencent.cn。

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

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

接口更新时间：2022-09-13 18:35:13。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：CreateKey
Version 是 否 String 公共参数，本接口取值：2019-01-18
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Description 否 否 String CMK 的描述，最大1024字节
Alias 是 否 String 作为密钥更容易辨识，更容易被人看懂的别名， 不可为空，1-60个字母数字 - _ 的组合，首字符必须为字母或者数字。以 kms- 作为前缀的用于云产品使用，Alias 不可重复。
KeyUsage 否 否 String 指定key的用途，默认为 "ENCRYPT_DECRYPT" 表示创建对称加解密密钥，其它支持用途 “ASYMMETRIC_DECRYPT_RSA_2048” 表示创建用于加解密的RSA2048非对称密钥，“ASYMMETRIC_DECRYPT_SM2” 表示创建用于加解密的SM2非对称密钥。可选值：ENCRYPT_DECRYPT，ASYMMETRIC_DECRYPT_RSA_2048，ASYMMETRIC_DECRYPT_SM2，ASYMMETRIC_SIGN_VERIFY_SM2，ASYMMETRIC_SIGN_VERIFY_RSA_2048，ASYMMETRIC_SIGN_VERIFY_ECC
Type 否 否 Uint64 指定key类型，默认为1，1表示默认类型，由KMS创建CMK密钥，2 表示EXTERNAL 类型，该类型需要用户导入密钥材料，参考 GetParametersForImport 和 ImportKeyMaterial 接口
Tags 否 否 Array of Tag 标签列表

3. 输出参数

参数名称 类型 描述
KeyId String CMK的全局唯一标识符
Alias String 作为密钥更容易辨识，更容易被人看懂的别名
CreateTime Uint64 密钥创建时间，unix时间戳
Description String CMK的描述
KeyState String CMK的状态
KeyUsage String CMK的用途
TagCode Uint64 标签操作的返回码. 0: 成功；1: 内部错误；2: 业务处理错误
TagMsg String 标签操作的返回信息
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameterValue.InvalidAlias 别名格式错误。
InvalidParameterValue.AliasAlreadyExists 别名已经存在。
LimitExceeded.CmkLimitExceeded CMK数量已达上限。
InvalidParameterValue.InvalidKeyUsage KeyUsage参数错误。
InvalidParameterValue.InvalidType Type参数错误。
InternalError 内部错误。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion 加密方式在当前region不支持。
InvalidParameterValue.TagsNotExisted 标签键或标签值不存在。
InvalidParameterValue.TagKeysDuplicated 标签键重复。
UnsupportedOperation.ServiceTemporaryUnavailable 服务暂时不可用。