文档首页> 数据加密服务 DEW> API参考> API说明> 管理加密密钥> 小数据加解密> 解密数据
更新时间：2023-05-09 GMT+08:00
查看PDF

解密数据

功能介绍

  • 功能介绍：解密数据。

接口约束

  • 解密非对称密钥加密的数据时，需要指定密钥ID和加密算法。如果指定的密钥和加密算法与用于加密数据的值不匹配，解密操作将失败。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1.0/{project_id}/kms/decrypt-data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

cipher_text

是

String

被加密数据密文。取值为加密数据结果中的cipher_text的值，满足正则匹配“^[0-9a-zA-Z+/=]{128,5648}$”。

encryption_algorithm

否

String

数据加密算法，仅使用非对称密钥需要指定该参数，默认值为“SYMMETRIC_DEFAULT”，合法枚举值如下：

  • SYMMETRIC_DEFAULT

  • RSAES_OAEP_SHA_256

  • SM2_ENCRYPT

key_id

否

String

密钥ID，36字节，满足正则匹配“^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$”。仅当密文使用非对称密钥加密时才需要此参数。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。

sequence

否

String

请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

key_id

String

密钥ID。

plain_text

String

明文。

plain_text_base64

String

明文的Base64值，在非对称加密场景下，若加密的明文中含有不可见字符，则解密结果以该值为准。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表6 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表10 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表12 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表14 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 502

表15 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表16 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 504

表17 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表18 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

{
  "cipher_text" : "AgDoAG7EsEc2OHpQxz4gDFDH54Cqwaelxxxxxxx",
  "encryption_algorithm" : "SYMMETRIC_DEFAULT"
}

响应示例

状态码： 200

请求已成功

{
  "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
  "plain_text" : "hello world",
  "plain_text_base64" : "aGVsbG8gd29ybGQ="
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在，资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码。

父主题： 小数据加解密