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.
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 Params. The value used for this API: EncryptByWhiteBox. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
Region | No | String | Common Params. This parameter is not required for this API. |
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. |
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. |
https://kms.tencentcloudapi.com/?Action=EncryptByWhiteBox
&KeyId=244dab8c-6dad-11ea-80c6-5254006d0810
&PlainText=UGxhaW5UZXh0
&<Common request parameters>
{
"Response": {
"RequestId": "4b3be01e-117a-43f5-aa34-dd5034efe3dd",
"InitializationVector": "BQbVImt3p_xr8VQebZaXGQ==",
"CipherText": "ZKHH2la4DpwlkwjANQ5hgw=="
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?