POST https://api.ctyun.cn/apiproxy/v3/product/createKey
参数 | 是否必填 | 参数位置 | 参数类型 | 说明 |
protectionLevel | 是 | body | String | 加密等级: 0:硬件 1:软件 |
keySpec | 是 | body | String | 密钥算法: 软件加密支持: 1. AES_256 2. RSA_2048 硬件加密支持: 1. AES_256 2. RSA_2048 3. Ctyun_SM2 4. Ctyun_SM4 |
regionId | 是 | body | String | 资源池id。 |
keyUsage | 是 | body | String | 密钥用途: 1. Encrypt/Decrypt 。 2. Sign/Verify(对称密钥不支持该用途,如AES_256,SM4等) |
enableAutomaticRotation | 是 | body | String | 是否开启密钥轮转(非对称密钥不能进行密钥轮转): true:开启 false:不开启 |
description | 否 | body | String | 密钥描述,长度不能大于8192。 |
rotationInterval | 否 | body | String | 密钥轮转周期:时间范围为7天-730天,只需要传数字+d即可(例如7d)。 |
origin | 是 | body | String | 密钥来源: 1. KMS 2. EXTERNAL(外部密钥) |
{
"statusCode": 800,
"returnObj": {
"code": 200,
"result": {
"automaticRotation": "1",
"cmkUuid": "8bca8f33-d42a-448a-866b-a064f44b29b7",
"creationDate": "Fri Jul 30 14:46:11 CST 2021",
"creator": "9fd671db0cc04c6d9f73e0169ba8d264",
"description": "测试创建密钥",
"keySpec": "AES_256",
"keyState": "1",
"keyUsage": "1",
"lastRotationDate": "Fri Jul 30 14:46:11 CST 2021",
"materialExpireTime": "null",
"origin": "1",
"protectionLevel": "1",
"regionId": "100054c0416811e9a6690242ac110002"
},
"statusCode": 200,
"success": 1
}
}
参数 | 说明 |
cmkUuid | 用户主密钥uuid。 |
automaticRotation | 是否开启自动密钥轮转,取值: 0: Enabled:自动轮转处于开启状态。 1: Disabled:自动轮转处于未开启状态。 2: Suspended:自动轮转被暂停执行 说明 仅适用于对称类型的CMK,非对称类型的CMK不支持自动轮转。 |
creationDate | 创建主密钥的日期和时间(UTC) |
creator | 主密钥创建者。 |
deleteDate | 主密钥的预计删除时间。 说明 只有当KeyState值为2:PendingDeletion时,返回该值。 |
description | 主密钥的描述。 |
keySpec | 主密钥的类型。 |
keyState | 密钥状态: 1:enabled(默认) 0:disabled 2:pendingdeletion 3:pendingimport(only EXTERNAL) |
keyUsage | 主密钥的用途。 |
lastRotationDate | 上一次轮转時間。 |
materialExpireTime | 密钥材料的过期时间(UTC)。当该值为空时,表示密钥材料不会过期。 |
nextRotationDate | 下一次轮转的时间。 说明:只有当AutomaticRotation参数值为Enabled或Suspended时,返回该值。 |
origin | 主密钥的密钥材料来源。 |
primaryKeyVersion | 对称类型主密钥的当前主版本标志符。 |
protectionLevel | 密钥的保护级别。 |
rotationInterval | 密钥自动轮转的周期 |
regionId | 资源池id |