tencent cloud



Last updated: 2022-01-18 17:21:40

1. API Description

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

This API is used to encrypt data with a white-box key.

A maximum of 100 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: EncryptByWhiteBox.
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. This API only supports: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai
KeyId Yes String Globally unique white-box key ID
PlainText Yes String Base64-encoded text to be encrypted. The size of the original text cannot exceed 4 KB.
InitializationVector No String Base64-encoded initialization vector of 16 bytes, which will be used by the encryption algorithm. If this parameter is not passed in, the backend service will generate a random one. You should save this value as a parameter for decryption.

3. Output Parameters

Parameter Name Type Description
InitializationVector String Base64-encoded initialization vector, which will be used by the encryption algorithm. If this parameter is passed in by the caller, it will be returned as-is; otherwise, the backend service will generate a random one and return it.
CipherText String Base64-encoded ciphertext after encryption
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Encrypting data with a white-box key

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "4b3be01e-117a-43f5-aa34-dd5034efe3dd",
    "InitializationVector": "BQbVImt3p_xr8VQebZaXGQ==",
    "CipherText": "ZKHH2la4DpwlkwjANQ5hgw=="

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.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.InvalidKeyId Invalid KeyId.
ResourceNotFound The resource does not exist.
ResourceUnavailable.KeyDisabled The key has been disabled.
ResourceUnavailable.NotPurchased The white-box key service has not been activated.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support