Encrypt

Last updated: 2020-02-11 20:24:54

1. API Description

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

This interface is used to encrypt any data up to 4KB, including database passwords, RSA Key, or other small sensitive information. For application data encryption, you can use the DataKey generated by GenerateDataKey to perform local data encryption and decryption operations.

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

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: Encrypt
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.

3. Output Parameters

Parameter Name Type Description
CiphertextBlob String Base64-encoded encrypted ciphertext
KeyId String
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1

Input Example

https://kms.tencentcloudapi.com/?Action=Encrypt
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&Plaintext=dGVzdCUyMHBsYWluJTIwdGV4dA==
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "816c6886-2147-4ee7-86f0-9400a7a398a5",
    "KeyId": "9999aed0-4956-11e9-bc70-5254005e86b4",
    "CiphertextBlob": "g2F8eQk44QrTbfj09TL17AZyFPgs8BTtZe2j27Wuw1YzTBCxnd0T/gwFQSasmtzxZi6mmvD7DCjCE+LxJmdhXQ==-k-zJshb0kBH7C2J5I3XXbbEg==-k-o1O+7H9HFAzWbCkftO2ZtPKewS3diSB4zGKOJhMn7LcKRhYr"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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.InvalidKeyId Invalid KeyId.
InvalidParameterValue.InvalidPlaintext Invalid Plaintext.
ResourceUnavailable.CmkDisabled CMK has been disabled.
ResourceUnavailable.CmkNotFound CMK does not exist.
UnauthorizedOperation Unauthorized operation