创建一个主密钥。

主密钥可直接用于加密少量数据(少于 6 KB),但通常用于生成可以加密大量数据的 DataKey,详情请参见GenerateDataKey

请求参数

名称 类型 是否必需 描述
Origin String 密钥材料来源。

有效值:Aliyun_KMS 或 EXTERNAL。

说明 有效值默认为 Aliyun_KMS。请注意区分大小写。
如果选择 EXTERNAL,您需要导入密钥材料
Description String 密钥的描述。长度必须在 0 到 8192 个字符之间。
KeyUsage String 密钥的用途。默认值:ENCRYPT/DECRYPT。
ProtectionLevel String 密钥的保护级别。
有效值:SOFTWARE 或 HSM。当指定值为 HSM 时:
  • 如果 Origin 为 Aliyun_KMS,则会在托管密码机中生成密钥,用于执行密码运算。
  • 如果 Origin 为 EXTERNAL,您可以将外部密钥导入到托管密码机中,用于执行密码运算。
说明 有效值默认为 SOFTWARE。请注意区分大小写。

返回参数

名称 类型 描述
KeyMetadata KeyMetadata 密钥的 metadata。

KeyMetadata

名称 类型 描述
CreationDate Timestamp 创建密钥时的日期和时间(UTC时间)。
Description String 密钥的描述。
KeyId String 密钥的全局唯一标识符。
KeyState String 密钥的状态,详情请参见用户主密钥(CMK)的状态(KeyState)对API调用的影响
KeyUsage String 密钥的用途,加密或解密。
DeleteDate Timestamp 密钥预计被删除的时间(UTC时间)。
  • 当该值为空时,表示密钥不会被删除。
  • 只有当 KeyState 值为 PendingDeletion 时,会返回此参数。
Creator String 密钥的创建者。
Arn String 当前密钥的阿里云资源名称。
Origin String 密钥材料来源。
MaterialExpireTime String 密钥材料过期时间(UTC时间)。当该值为空时,表示密钥材料不会过期。
ProtectionLevel String 密钥的保护级别。

示例

请求示例

https://kms.cn-hangzhou.aliyuncs.com/?Action=CreateKey
&Description=<your key description>
&KeyUsage=ENCRYPT/DECRYPT
&Origin=<key origin, default Aliyun_KMS>
&ProtectionLevel=HSM
&<公共请求参数>

返回示例

JSON 格式

//json response
{
        "KeyMetadata": {
                "CreationDate": "2016-03-25T10:42:40Z",
                "Description": "key description example",
                "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
                "KeyState": "Enabled",
                "KeyUsage": "ENCRYPT/DECRYPT",
                "DeleteDate": "",
                "Creator":"123456",
                "Arn":"acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
                "Origin":"Aliyun_KMS",
                "MaterialExpireTime":"",
                "ProtectionLevel":"HSM"
        },
        "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

XML 格式

//xml response
<KMS>
 <KeyMetadata>
        <CreationDate>2016-03-25T10:40:47Z</CreationDate>
        <Description>key description example</Description>
        <KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</KeyId>
        <KeyState>Enabled</KeyState>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <DeleteDate></DeleteDate>
        <Creator>123456</Creator>
        <Arn>acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</Arn>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime></MaterialExpireTime>
        <ProtectionLevel>HSM</ProtectionLevel>
 </KeyMetadata>
 <RequestId>6cb4bf6b-d9c9-4660-af5f-2328378e7257</RequestId>
</KMS>