AsymmetricRsaDecrypt

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-02-04 10:25:36

Download PDF

1. API Description

Domain name for API request: kms.tencentcloudapi.com.

This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in Enabled state for decryption.

A maximum of 200 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: AsymmetricRsaDecrypt.
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.
KeyId	Yes	String	Unique CMK ID
Ciphertext	Yes	String	Base64-encoded ciphertext encrypted with `PublicKey`
Algorithm	Yes	String	Corresponding algorithm when a public key is used for encryption. Valid values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256

3. Output Parameters

Parameter Name	Type	Description
KeyId	String	Unique CMK ID
Plaintext	String	Base64-encoded plaintext after decryption
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Decrypting data with RSA asymmetric key

Input Example

https://kms.tencentcloudapi.com/?Action=AsymmetricRsaDecrypt
&KeyId=554ef4b3-3071-11ea-a86a-5254006d0810
&Ciphertext=Fb0UICocErQgNEkYKJagtoKNed7DLeo5UkZzPJMyI94CfWh6yKHGgb/0PBHrCve2Avo4gJI5pJMWP3Aq5ggX0aunLv87UX+sgO1/3HXW+q4ARaiwZ9Q73RQuPg6qJ2Eg33uZ2Xjey3l+5yHiOdZYmCVePtKAsuhxzKw/sALTbGTYYnbJXnGKr3Yu7Hs0hCC1bOz0sNqd1IXdUyMtQtbDOV8NWg2ecdZPIOdbnrCKIQ4rpMUghjSFv3rSHo5VbpuOGPXqEZT4goou42psIXb03li3TXxFZMTAdxVMzpqEuTfRxiMPEqyPEHe6xG92vJX0FZfWU8Y5SxlfXp+mvBbAmw==
&Algorithm=RSAES_OAEP_SHA_1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "7c076c83-1402-41d8-8ce6-73a350a9eaf6",
    "KeyId": "554ef4b3-3071-11ea-a86a-5254006d0810",
    "Plaintext": "dGVzdA=="
  }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation.DecryptError	Decryption failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue.InvalidKeyId	Invalid `KeyId`.
InvalidParameterValue.InvalidKeyUsage	Incorrect `KeyUsage` parameter.
ResourceUnavailable.CmkNotFound	The CMK does not exist.
ResourceUnavailable.CmkStateNotSupport	This operation cannot be performed under the current CMK status.
UnauthorizedOperation	Unauthorized operation.

Recent Pages