描述
创建用户主密钥(Customer Master Key, CMK)。主密钥可以直接用来对小包数据进行加密(一般小于4KB),同时也用来产生数据密钥(DataKey,DK),该数据密钥可用来对本地大量磁盘数据进行加解密操作。
请求参数
名称 |
类型 |
是否必需 |
描述 |
---|---|---|---|
description |
String |
否 |
密钥的描述 |
keyUsage |
Integer |
是 |
密钥用途。目前该版本仅支持值为0,默认传0。注:(0:"ENCRYPT/DECRYPT") |
alias |
String |
是 |
密钥名称。注:唯一,不能重复 |
algorithm |
String |
是 |
加密算法。默认RSA(国际标准支持:RSA,国密标准支持SM2) |
origin |
Integer |
是 |
密钥材料来源。支持平安云KMS平台产生、外部导入两种来源。注:(0: "平台产生"),(1:"外部导入") |
返回参数
名称 |
类型 |
描述 |
---|---|---|
code |
String |
返回码,成功返回"SUCCESS" |
keyMetadata |
KeyMetadata |
返回密钥信息 |
requestId |
String |
当前请求Id |
KeyMetadata
名称 |
类型 |
描述 |
---|---|---|
keyId |
String |
密钥的全局唯一标识符 |
alias |
String |
密钥名称 |
keyUsage |
String |
密钥用途,加密/解密 |
description |
String |
密钥描述 |
creationDate |
String |
密钥创建时间(yyyy-MM-dd HH:mm:ss) |
deleteDate |
String |
密钥预计被删除时间(yyyy-MM-dd HH:mm:ss)当该值为空时,表示密钥不会被删除。只有当密钥状态keyState是待删除PendingDeletion时,会返回这个参数 |
ownerId |
String |
密钥拥有者 |
keyState |
String |
密钥状态。0启用;1禁用;2待删除。 |
origin |
String |
密钥材料来源。 |
请求示例
https:// kms-cn-shanghai.yun.pingan.com/?action=CreateCmk
&keyUsage=0
&origin=
&alias=
&algorithm=
&description=
&<公共请求参数>
返回示例
{
"code":"SUCCESS",
"keyMetadata":{
"keyUsage":"ENCRYPT_DECRYPT",
"origin":"平安云产生",
"keyState":"ENABLE|已启用",
"keyId":"your key id",
"description":"key description example",
"alias":"your key alias",
"ownerId":"123456",
"creationDate":"2018-12-04 15:07:54"
}
"requestId":"53912b71-3435-409e-ad05-1882ced04f1f"
}