key_info KeyDescripti
4.1.2 数据密钥管理
4.1.2.3 创建不含明文数据密钥 功能介绍功能介绍
● 功能介绍:创建数据密钥,返回结果只包含密文。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.0/{project_id}/kms/create-datakey-without-plaintext
表4-168 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
请求参数
表4-169 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)。
表4-170 请求 Body 参数
参数 是否必选 参数类型 描述
key_id 是 String 密钥ID,36字节,满足正则匹
配“^[0-9a-z]{8}-z]{4}-[0-9a- [0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。 例如:0d0466b0-
e727-4d9c-b35d-f84bb474a37f。
key_spec 否 String 指定生成的密钥bit位长度。有 效值:AES_256、AES_128。
● AES_256:表示256比特的对 称密钥。
● AES_128:表示128比特的对 称密钥。 说明:
datakey_length和key_spec 二选一。
● 若datakey_length和 key_spec都为空,默认生成 256bit的密钥。
● 若datakey_length和 key_spec都指定了值,仅 datakey_length生效。
datakey_lengt
h 否 String 密钥bit位长度。取值为8的倍
数,取值范围为8~8192。 说 明: datakey_length和 key_spec二选一。
● 若datakey_length和 key_spec都为空,默认生成 256bit的密钥。
● 若datakey_length和 key_spec都指定了值,仅 datakey_length生效。
sequence 否 String 请求消息序列号,36字节序列 号。 例如:
919c82d4-8046-4722-9094-35 c3c6524cff
响应参数
状态码: 200
表4-171 响应 Body 参数
参数 参数类型 描述
key_id String 密钥ID。
cipher_text String DEK密文16进制,两位表示1byte。
状态码: 400
表4-172 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-173 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 401
表4-174 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-175 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 403
表4-176 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-177 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 404
表4-178 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-179 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 500
表4-180 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-181 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 502
表4-182 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-183 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 504
表4-184 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-185 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
请求示例
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "datakey_length" : "512"
}
响应示例
状态码: 200 请求已成功
状态码
状态码 描述
200 请求已成功
400 请求参数有误
401 被请求的页面需要用户名和密码
403 认证失败
404 资源不存在,资源未找到 500 服务内部错误
502 请求未完成。服务器从上游服务器收到一个无效的响应
504 网关超时
错误码
请参见错误码。