接口约束
4.1.5 小数据加解密
4.1.5.2 解密数据
功能介绍
● 功能介绍:解密数据。
接口约束
● 解密非对称密钥加密的数据时,需要指定密钥ID和加密算法。如果指定的密钥和 加密算法与用于加密数据的值不匹配,解密操作将失败。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.0/{project_id}/kms/decrypt-data
表4-382 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
请求参数
表4-383 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)。
表4-384 请求 Body 参数
参数 是否必选 参数类型 描述
cipher_text 是 String 被加密数据密文。取值为加密数 据结果中的cipher_text的值,满 足正则匹配“^[0-9a-zA-Z+/=]
{128,5648}$”。
encryption_al
gorithm 否 String 数据加密算法,仅使用非对称密
钥需要指定该参数,默认值为
“SYMMETRIC_DEFAULT”,
合法枚举值如下:
● SYMMETRIC_DEFAULT
● RSAES_OAEP_SHA_256
● SM2_ENCRYPT
key_id 否 String 密钥ID,36字节,满足正则匹
sequence 否 String 请求消息序列号,36字节序列 号。 例如:
919c82d4-8046-4722-9094-35 c3c6524cff
响应参数
状态码: 200
表4-385 响应 Body 参数
参数 参数类型 描述
key_id String 密钥ID。
plain_text String 明文。
plain_text_bas
e64 String 明文的Base64值,在非对称加密场景下,若加密 的明文中含有不可见字符,则解密结果以该值为 准。
状态码: 400
表4-386 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-387 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 401
表4-388 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-389 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
表4-390 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-391 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 404
表4-392 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-393 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 500
表4-394 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-395 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 502
表4-396 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-397 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码: 504
表4-398 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-399 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
请求示例
{ "cipher_text" : "AgDoAG7EsEc2OHpQxz4gDFDH54Cqwaelxxxxxxx", "encryption_algorithm" : "SYMMETRIC_DEFAULT"
}
响应示例
状态码: 200 请求已成功
状态码
状态码 描述
200 请求已成功
400 请求参数有误
401 被请求的页面需要用户名和密码
403 认证失败
404 资源不存在,资源未找到 500 服务内部错误
502 请求未完成。服务器从上游服务器收到一个无效的响应
504 网关超时
错误码
请参见错误码。