Decrypting Data

Updated on 2025-05-20 GMT+08:00

View PDF

To decrypt data that was encrypted using an asymmetric key, specify the key ID and encryption algorithm. If the specified key and encryption algorithm do not match those used for data encryption, the decryption will fail.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
cipher_text	Yes	String	Ciphertext of encrypted data. Its is the value of cipher_text in the data encryption result and matches the regular expression ^[0-9a-zA-Z+/=]{188,5648}$.
encryption_algorithm	No	String	Data encryption algorithm. This parameter must be specified if an asymmetric key is used. The default value is SYMMETRIC_DEFAULT. Valid values are as follows: SYMMETRIC_DEFAULT RSAES_OAEP_SHA_256
key_id	No	String	36-byte ID of a CMK that matches the regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$. This parameter must be specified if the ciphertext is encrypted using an asymmetric key. Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
sequence	No	String	36-byte sequence number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
key_id	String	Key ID.
plain_text	String	Plaintext.
plain_text_base64	String	Base64 value in plaintext. In asymmetric encryption, if the encrypted plaintext contains invisible characters, the Base64 value will be used as the decryption result.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 6** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 8** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 10** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 12** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 14** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 502

**Table 15** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 16** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 504

**Table 17** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 18** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

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

Status code: 200

Request processing succeeded.

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


Status Code	Description
200	Request processing succeeded.
400	Invalid request parameters.
401	You must enter a username and password to access the requested page.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	Failed to complete the request. The server received an invalid response.
504	Gateway timed out.