文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理加密密钥/ 密钥空间/ 创建密钥胶囊 - CreateDatakeyCapsule
更新时间:2026-08-18 GMT+08:00
分享

创建密钥胶囊 - CreateDatakeyCapsule

功能介绍

创建密钥胶囊

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    kms:cmk:createDatakeyCapsule

    Write

    KeyId *

    -

    -

    -

URI

POST /v1.0/{project_id}/kms/datakey-capsule/create

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

key_id

String

参数解释:

密钥ID

约束限制:

UUID格式,满足正则表达式^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

取值范围:

不涉及

默认取值:

不涉及

datakey_length

String

参数解释:

待创建的数据密钥长度

约束限制:

256或者128二选一

取值范围:

  • 128

  • 256

默认取值:

不涉及

public_key

String

参数解释:

公钥信息,使用RSAES_OAEP_SHA_256算法加密;如果传递了public_key,KMS会使用该公钥对明文数据密钥进行加密,并返回加密后的数据密钥

约束限制:

仅支持RSA公钥

取值范围:

不涉及

默认取值:

不涉及

policy_id

String

参数解释:

密钥策略ID和内联的密钥策略二选一

约束限制:

仅支持RSA公钥

取值范围:

不涉及

默认取值:

不涉及

key_policy

String

参数解释:

密钥策略ID和内联的密钥策略二选一

约束限制:

仅支持RSA公钥

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

key_id

String

参数解释:

密钥ID

取值范围:

不涉及

datakey

String

参数解释:

datakey和datakey_cipher响应二选一,如果请求参数中没传递public_key,则返回datakey

取值范围:

不涉及

datakey_cipher

String

参数解释:

datakey和datakey_cipher响应二选一,如果请求参数中传递了public_key,使用public_key加密datakey后返回datakey_cipher

取值范围:

不涉及

datakey_capsule

String

参数解释:

密钥胶囊

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档