CreateKey - 创建用户主密钥--密钥管理系统-火山引擎

文档中心

立即注册

导航

CreateKey - 创建用户主密钥

最近更新时间：2024.08.29 17:20:51首次发布时间：2024.08.29 17:20:51

创建用户主密钥

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateKey	要执行的操作，取值：CreateKey。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	是	keyring-test	密钥环名称长度为 2 - 31 个字符合法字符：[a-zA-Z0-9-_]
KeyName	String	是	key-test	主密钥名称长度为 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
Description	String	否	test	密钥描述长度为 0 - 8192 个字符
KeyUsage	String	否	ENCRYPT_DECRYPT	密钥用途，取值： ENCRYPT_DECRYPT SIGN_VERIFY
ProtectionLevel	String	否	SOFTWARE	密钥保护级别，取值： SOFTWARE HSM
RotateState	String	否	Enable	密钥轮转状态，取值： Enable Disable
Origin	String	否	CloudKMS	密钥来源，取值： CloudKMS External

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Key	Object	Key 结构的数据	主密钥信息

请求示例

GET /?Action=CreateKey&Version=2021-02-18&KeyringName=demo&KeyName=demo&KeySpec=SYMMETRIC_256&Description=demo&KeyUsage=ENCRYPT_DECRYPT&ProtectionLevel=SOFTWARE&RotateState=Enable&Origin=CloudKMS HTTP/1.1
Host: kms.volcengineapi.com
X-Date: 20240707T150834Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240707/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240707231112068082115004555B91",
    "Action": "CreateKey",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Key": {
      "ID": "d24a9f14-1a8b-4393-b66e-b77b766b5735",
      "CreationDate": 1625818017,
      "UpdateDate": 1625818017591,
      "KeyName": "demo",
      "KeySpec": "SYMMETRIC_256",
      "Description": "demo",
      "KeyState": "Enable",
      "KeyUsage": "ENCRYPT_DECRYPT",
      "ProtectionLevel": "SOFTWARE",
      "Origin": "CloudKMS"
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	InvalidParameter	The request parameter %s is invalid.
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
403	AccessDenied	User is not authorized to do this action
404	Not Found	Not found %s [%s].
409	Conflict	The %s resource %s is conflict.
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.