加密数据
功能介绍
-
功能介绍：加密数据，用指定的用户主密钥加密数据。
接口约束
-
使用非对称密钥加密数据时，请记录选择的密钥ID和加密算法。解密数据时，您将需要提供相同的密钥ID和加密算法。如果指定的密钥和加密算法与用于加密数据的值不匹配，解密操作将失败。
-
使用对称密钥解密时，不需要提供密钥ID和加密算法，KMS会将此信息存储在密文中。KMS无法将元数据存储在使用非对称密钥生成的密文中，非对称密钥密文的标准格式不包括可配置字段。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1.0/{project_id}/kms/encrypt-data
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key_id |
是 |
String |
密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 |
|
plain_text |
是 |
String |
明文数据，1~4096字节，满足正则匹配“^.{1,4096}$”，且转化为byte数组后长度取值范围为1~4096字节。 |
|
encryption_algorithm |
否 |
String |
数据加密算法，仅使用非对称密钥需要指定该参数，默认值为“SYMMETRIC_DEFAULT”，合法枚举值如下：
|
|
sequence |
否 |
String |
请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key_id |
String |
密钥ID。 |
|
cipher_text |
String |
加密后的密文，使用了Base64编码 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 502
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 504
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
请求示例
使用ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的用户主密钥加密明文数据“hello world”，数据加密算法为"SYMMETRIC_DEFAULT"。
{
"key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"plain_text" : "hello world",
"encryption_algorithm" : "SYMMETRIC_DEFAULT"
}响应示例
状态码： 200
请求已成功
{
"key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"cipher_text" : "AgDoAG7EsEc2OHpQxz4gDFDH54CqwaelpTdEl+RFXXX..."
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
|
400 |
请求参数有误 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
认证失败 |
|
404 |
资源不存在，资源未找到 |
|
500 |
服务内部错误 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
504 |
网关超时 |
错误码
请参见错误码。
