文档中心

创建用户主密钥

最近更新时间：2023.06.21 16:55:00

首次发布时间：2021.11.24 19:45:10

描述
创建用户主密钥

密钥管理类型	密钥类型	密钥规格	支持的加密算法	支持的签名算法
软件密钥	对称密钥	SYMMETRIC_256	AES-256-GCM	-
	非对称密钥	RSA_2048 RSA_3072 RSA_4096	RSAES_OAEP_SHA_256	RSA_PSS_SHA_256 RSA_PSS_SHA_384 RSA_PSS_SHA_512 RSA_PKCS1_SHA_256 RSA_PKCS1_SHA_384 RSA_PKCS1_SHA_512
		EC_P256 EC_P256K	-	ECDSA_SHA_256
		EC_P384	-	ECDSA_SHA_384
		EC_P521	-	ECDSA_SHA_512
硬件密钥	对称密钥	SYMMETRIC_128	SM4-128-GCM	-
	对称密钥	SYMMETRIC_256	AES-256-GCM	-
	非对称密钥	RSA_2048 RSA_3072 RSA_4096	RSAES_OAEP_SHA_256	RSA_PSS_SHA_256 RSA_PSS_SHA_384 RSA_PSS_SHA_512 RSA_PKCS1_SHA_256 RSA_PKCS1_SHA_384 RSA_PKCS1_SHA_512
		EC_P256 EC_P256K	-	ECDSA_SHA_256
		EC_P384	-	ECDSA_SHA_384
		EC_P521	-	ECDSA_SHA_512
		EC_SM2	SM2PKE	SM2_DSA

请求业务参数

名称	类型	是否必选	示范值	描述
Action	是	string	CreateKey	接口名，取值：CreateKey
Version	是	string	2021-02-18	版本号，取值：2021-02-18
KeyringName	String	是	test_keyring-1	密钥环的别名。长度为 2 - 31 个字符合法字符：[a-zA-Z0-9-_]
KeyName	String	是	test_key-1	密钥的别名。长度为 2 - 31 个字符合法字符：[a-zA-Z0-9-_]
KeySpec	String	否	SYMMETRIC_256	对称密钥 SYMMETRIC_256 SYMMETRIC_128 非对称： RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P256K EC_P384 EC_P521 EC_SM2
KeyUsage	String	否	ENCRYPT_DECRYPT	密钥用途，取值： ENCRYPT_DECRYPT SIGN_VERIFY
Description	String	否	Example description	密钥的描述。长度为 0 - 8192 个字符。
ProtectionLevel	String	否	SOFTWARE	密钥保护级别，取值： SOFTWARE HSM

返回业务参数

名称	类型	描述
ResponseMetaData	ResponseMetaData	返回公共参数
Result	Key	密钥元数据

请求示例

https://kms.volcengineapi.com?Action=CreateKey&Version=2021-02-18&KeyringName=test_keyring-1&KeyName=test_key-1

返回示例

{
    "ResponseMetadata":{
        "RequestId":"DBFD8037-904D-4DD2-9BDB-BDF743E545B5",
        "Action":"CreateKey",
        "Version":"2021-02-18",
        "Service":"kms",
        "Region":"cn-north-1"
    },
    "Result":{
        "Keys":[
            {
                "ID":"d24a9f14-1a8b-4393-b66e-b77b766b5735",
                "CreationDate":1625818017,
                "UpdateDate":1625818017591,
                "KeyName":"test_key-1",
                "KeySpec":"SYMMETRIC_256",
                "Description":"",
                "KeyState":"Enable",
                "KeyUsage":"ENCRYPT_DECRYPT",
                "ProtectionLevel":"SOFTWARE",
                "Origin":"CloudKMS"
            }
        ]
    }
}

密钥管理系统

创建用户主密钥