Last updated: 2020-12-02 11:27:35

1. API Description

Domain name for API request:

This API is used to decrypt the ciphertext and obtain the plaintext data.

A maximum of 300 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: Decrypt.
Version Yes String Common parameter. The value used for this API: 2019-01-18.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
CiphertextBlob Yes String The ciphertext data to be decrypted.
EncryptionContext No String JSON string of key-value pair. If this parameter is specified for Encrypt, the same parameter needs to be provided when the Decrypt API is called. The maximum length is 1,024 bytes.

3. Output Parameters

Parameter Name Type Description
KeyId String Globally unique CMK ID
Plaintext String Decrypted plaintext. This field is Base64-encoded. In order to get the original plaintext, the Base64-decoding is needed
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Decrypting

This example shows you how to decrypt the ciphertext.

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
    "Plaintext": "dGVzdCUyMHBsYWluJTIwdGV4dA==",
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidCiphertext Incorrect ciphertext format
ResourceUnavailable.CmkDisabled The CMK has been disabled.
ResourceUnavailable.CmkNotFound The CMK does not exist.
UnauthorizedOperation Unauthorized operation.