Decrypting Data¶

Function¶

This API enables you to decrypt data.

URI¶

URI format
POST /v1.0/{project_id}/kms/decrypt-data
Parameter description
Table 1 Parameter description¶
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Requests¶

**Table 2** Request parameters¶
Parameter	Mandatory	Type	Description
cipher_text	Yes	String	Ciphertext of encrypted data. The value is the cipher_text value in the data encryption result that matches the regular expression ^[0-9a-zA-Z+/=]{188,5648}$.
encryption_context	No	Object	Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity. If this parameter is specified during encryption, it is also required for decryption. Example: {"Key1":"Value1","Key2":"Value2"}
sequence	No	String	36-byte serial number of a request message Example: 919c82d4-8046-4722-9094-35c3c6524cff

Responses¶

**Table 3** Response parameters¶
Parameter	Mandatory	Type	Description
key_id	Yes	String	CMK ID
plain_text	Yes	String	Plaintext

Examples¶

The following example describes how to decrypt data (ciphertext: AgDoAG7EsEc2OHpQxz4gDFDH54CqwaelpTdEl+RFPjbKn5klPTvOywYIeZX60kPbFsYOpXJwkL32HUM50MY22Eb1fOSpZK7WJpYjx66EWOkJvO+Ey3r1dLdNAjrZrYzQlxRwNS05CaNKoX5rr3NoDnmv+UNobaiS25muLLiqOt6UrStaWow9AUyOHSzl+BrX2Vu0whv74djK+3COO6cXT2CBO6WajTJsOgYdxMfv24KWSKw0TqvHe8XDKASQGKdgfI74hzI1YWJlNjlmLWFlMTAtNDRjZC1iYzg3LTFiZGExZGUzYjdkNwAAAACdcfNpLXwDUPH3023MvZK8RPHe129k6VdNIi3zNb0eFQ==).

Example request

{
     "cipher_text": "AgDoAG7EsEc2OHpQxz4gDFDH54CqwaelpTdEl+RFPjbKn5klPTvOywYIeZX60kPbFsYOpXJwkL32HUM50MY22Eb1fOSpZK7WJpYjx66EWOkJvO+Ey3r1dLdNAjrZrYzQlxRwNS05CaNKoX5rr3NoDnmv+UNobaiS25muLLiqOt6UrStaWow9AUyOHSzl+BrX2Vu0whv74djK+3COO6cXT2CBO6WajTJsOgYdxMfv24KWSKw0TqvHe8XDKASQGKdgfI74hzI1YWJlNjlmLWFlMTAtNDRjZC1iYzg3LTFiZGExZGUzYjdkNwAAAACdcfNpLXwDUPH3023MvZK8RPHe129k6VdNIi3zNb0eFQ=="
}

Example response

{
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "plain_text": "12345678"
}

{
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

Status Codes¶

Table 4 lists the normal status code returned by the response.

**Table 4** Status codes¶
Status Code	Status	Description
200	OK	Request processed successfully.

Exception status code. For details, see Status Codes.

last updated: 2024-11-08 14:06 UTC - commit: 5674aac1874f8e8728192583f58d6e232d714273