CreateKey
更新时间：2023-03-02
CreateKey
- 接口描述
用于创建一个密钥CMK。
- 请求URI
Plain Text
1POST /?action=CreateKey请求体参数
- 请求体字段数据结构说明
| 参数 | 类型 | 是否必需 | 描述 | 示例值 |
|---|---|---|---|---|
| description | String | 否 | 密钥描述 | |
| keyUsage | String | 否 | 密钥用途 | ENCRYPT_DECRYPT |
| keySpec | String | 是 | 密钥类型：BAIDU_AES_256 / AES_128 / AES_256 / SM1_128 / SM4_128 / RSA_1024 / RSA_2048 / RSA_4096 / SM2_256 | BAIDU_AES_256 |
| protectedBy | String | 是 | 保护级别：SOFTWARE / HSM | HSM |
| origin | String | 是 | 密钥来源：EXTERNAL / BAIDU_KMS | EXTERNAL |
| rotateCycle | Integer | 否 | 轮转周期：7~365 | 7 |
- 支持的创建密钥参数
| 密钥类型 | 密钥来源 | 保护类型 | 是否支持 | |
|---|---|---|---|---|
| 对称密钥 | ||||
| AES_128 | BAIDU_KMS | SOFTWARE | 支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| AES_256 | BAIDU_KMS | SOFTWARE | 支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| SM1_128 | BAIDU_KMS | SOFTWARE | 不支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| SM4_128 | BAIDU_KMS | SOFTWARE | 不支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| 非对称密钥 | ||||
| RSA_1024 | BAIDU_KMS | SOFTWARE | 不支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| RSA_2048 | BAIDU_KMS | SOFTWARE | 不支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| RSA_4096 | BAIDU_KMS | SOFTWARE | 不支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 | ||
| SM2_256 | BAIDU_KMS | SOFTWARE | 不支持 | |
| HSM | 支持 | |||
| EXTERNAL | HSM | 支持 |
响应体参数
- 响应体字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| keyMetadata | keyMetadata | 密钥元数据 |
- KeyMetadata字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| keyId | String | 密钥id | |
| creationDate | String | 密钥创建时间 | 2018-08-15T13:58:18Z |
| keyState | String | 密钥状态，有以下几种：pendingImport(待导入)、pendingDeletion(待删除)、enabled(启用)、disabled(禁用) | enabled |
| description | String | 密钥描述 | |
| deletionDate | String | 计划删除时间 | 2018-08-15T13:58:18Z |
| region | String | 区域 | bj |
| origin | String | 密钥来源 | BAIDU_KMS |
| keySpec | String | 密钥类型 | BAIDU_AES_256 |
| keyUsage | String | 密钥用途 | ENCRYPT_DECRYPT |
| protectedBy | String | 密钥保护级别 | SOFTWARE |
| rotateCycle | Integer | 轮转周期 | 200 |
| nextRotateTime | String | 下次轮转时间 | 2018-08-15T13:58:18Z |
请求示例
Plain Text
1POST /?action=CreateKey
2<公共请求头>
3
4{
5 "keyUsage" : "ENCRYPT_DECRYPT",
6 "rotateCycle" : 7,
7 "origin" : "EXTERNAL",
8 "description" : "description",
9 "protectedBy" : "SOFTWARE",
10 "keySpec" : "BAIDU_AES_256"
11}响应示例
Plain Text
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "keyMetadata": {
6 "keyId": "5be45b47-38ba-f055-e892-25ff66c91adc",
7 "creationDate": "2018-08-13T13:58:18Z",
8 "keyState": "enabled",
9 "description": "test",
10 "deletionDate": "2018-09-15T13:20:14Z",
11 "keyUsage": "ENCRYPT_DECRYPT",
12 "region": "bj",
13 "origin": "string",
14 "keySpec": "string",
15 "protectedBy": "string",
16 "rotateCycle":300,
17 "nextRotateTime":"2018-09-15T13:20:14Z"
18 }
19}