创建用户主密钥
更新时间 2025-09-19 14:46:48
最近更新时间: 2025-09-19 14:46:48
接口功能介绍
创建用户主密钥接口，可以创建多种对称，非对称密钥
接口约束
请保证账户余额大于0
URI
POST /v1/cmkManage/createKey
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| protectionLevel | 是 | String | 保护等级，0为硬件，1为软件 | 0 | |
| keySpec | 是 | String | 支持的加密算法 | AES_256 | |
| keyUsage | 是 | String | 密钥类型1-加密解密 2-签名验签 | 1 | |
| description | 否 | String | 密钥描述，长度小于8129 | 存储加密密钥 | |
| enableAutomaticRotation | 是 | String | 是否开启轮转（true/false） | true | |
| rotationInterval | 是 | String | 轮转周期（当enableAutomaticRotation参数为true时，必传，范围为7d-730d） | 7d | |
| origin | 是 | String | 密钥来源 1-KMS 2-外部密钥 | 1 | |
| aliasName | 否 | String | 密钥别名 | ECS | |
| epId | 是 | String | 企业项目id | 0 | |
| instanceId | 否 | String | 实例Id，非必传，当为空时密钥创建在最早开通且启用中的实例中 | ins-Xk8C6r |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：200 成功 | 200 | |
| error | String | 错误码 | KMS_0514 | |
| message | String | 调用结果信息 | 用戶主密钥创建成功 | |
| returnObj | Object | 接口返回结果 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deleteDate | String | 密钥删除时间 | Tue Oct 25 15:06:52 CST 2022 | |
| rotationInterval | String | 轮转周期 | 7d | |
| nextRotationDate | String | 下次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| creationDate | String | 密钥创建时间 | Tue Oct 25 15:06:52 CST 2022 | |
| description | String | 密钥描述 | 密钥描述，长度小于8129 | Tue Oct 25 15:06:52 CST 2022 |
| cmkUuid | String | 密钥唯一标识 | 474e569e-8814-474a-948b-dbcf6d853eff | |
| keyState | String | 密钥状态 | 1 | |
| keyUsage | String | 密钥类型1-加密解密 2-签名验签 | 1 | |
| lastRotationDate | String | 上一次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| creator | String | 密钥所属用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| protectionLevel | String | 密钥保护级别 | 保护等级，0为硬件，1为软件 | |
| origin | String | 密钥来源 1-KMS 2-外部密钥 | 1 | |
| automaticRotation | String | 是否开启轮转取值0，1，2 | 1 | |
| materialExpireTime | String | 密钥材料过期时间 | Tue Oct 25 15:06:52 CST 2022 | |
| keySpec | String | 密钥类型 | AES_256 | |
| aliasName | String | 密钥别名 | ECS | |
| regionId | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg | |
| primaryKeyVersion | String | 密钥版本 | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 | |
| requestId | String | 请求id | 4d3edaeb-9968-4fed-80f9-e42f487b9cc7 |
枚举参数
无
请求示例
请求url
无
请求头header
{ "hmac": "B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw=", "requestDate": "Wed, 29 Aug 2023 17:05:01 CST", "accessKey": "ae2cc5cc5e8211ea978a186590d96509", "userId":"562b89493b1a40e1b97ea05e50dd8170", "regionId":"fecnjniakfkn2314ndekqldedcsadfg"}
请求体body
{ "protectionLevel":"1", "keySpec":"AES_256", "keyUsage":"1", "description":"", "enableAutomaticRotation":"true", "rotationInterval":"7d", "origin":1, "aliasName":"tdesdt_ali1adddddadcccdsasdas", "instanceId":"ins-Xk8C6r"}
响应示例
{ "statusCode": "200", "message": "用戶主密钥创建成功", "returnObj": { "deleteDate": null, "rotationInterval": null, "nextRotationDate": null, "creationDate": "Tue Oct 25 15:06:52 CST 2022", "description": "", "cmkUuid": "474e569e-8814-474a-948b-dbcf6d853eff", "keyState": "1", "keyUsage": "1", "lastRotationDate": "Tue Oct 25 15:06:52 CST 2022", "creator": "1123", "protectionLevel": "1", "origin": "1", "automaticRotation": "1", "materialExpireTime": "null", "keySpec": "AES_256", "aliasName": "tdesdt_ali1adddddadcccdsasdas", "regionId": "123", "primaryKeyVersion": "f2ffbff9-940a-41a4-ba9a-fe1fd8f22792" }}
状态码
请参考 状态码
错误码
请参考 错误码
