key_info KeyDescripti
4.1.2 数据密钥管理
4.1.2.4 加密数据密钥 功能介绍功能介绍
● 功能介绍:加密数据密钥,用指定的主密钥加密数据密钥。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.0/{project_id}/kms/encrypt-datakey
表4-186 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
请求参数
表4-187 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)。
表4-188 请求 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。
plain_text 是 String CMK为AES时,DEK明文和DEK 明文的SHA256(32字节);
CMK为SM4时,DEK明文和DEK 明文的SM3(32字节),均为 16进制字符串表示。
datakey_plain
_length 是 String DEK明文字节长度,取值范围为 1~1024。 DEK明文字节长度,
取值为“64”。
sequence 否 String 请求消息序列号,36字节序列 号。 例如:
key_id String 密钥ID
cipher_text String DEK密文16进制,两位表示1byte。
状态码: 400
表4-190 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-191 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 401
表4-192 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-193 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 403
表4-194 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-195 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 404
表4-196 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-197 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 500
表4-198 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-199 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 502
表4-200 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-201 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 504
表4-202 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-203 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
请求示例
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "plain_text" :
"7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512 525e527b10331100f357bf42125d8d5ced94ffbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305f b9540f797",
"datakey_plain_length" : "64"
}
响应示例
状态码: 200 请求已成功
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "datakey_length" : "64",
"cipher_text" : "020098009EEAFCE122CAA5927D2XXX..."
}
状态码
状态码 描述
200 请求已成功
400 请求参数有误
401 被请求的页面需要用户名和密码
403 认证失败
404 资源不存在,资源未找到 500 服务内部错误
502 请求未完成。服务器从上游服务器收到一个无效的响应
504 网关超时
错误码
请参见错误码。