EnableTransparentDataEncryption

Last updated: 2025-12-03 10:42:02

EnableTransparentDataEncryption

Last updated: 2025-12-03 10:42:02

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to enable the transparent data encryption (TDE) capability for TencentDB for MongoDB.

A maximum of 20 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 Params. The value used for this API: EnableTransparentDataEncryption.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID. For example, cmgo-p8vn****. Log in to theTencentDB for MongoDB console to copy the instance ID from the instance list. Currently, the supported general versions include 4.4 and 5.0, and Cloud Disk Edition is not supported.
KmsRegion	Yes	String	Region where the Key Management Service (KMS) instance is located. For example, ap-shanghai.
KeyId	No	String	Key ID. If the parameter is left unspecified, there is no specific key ID, Tencent Cloud will generate the key automatically.

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Asynchronous process ID for enabling TDE, which is used for querying the process status.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Enabling TDE for an Instance

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableTransparentDataEncryption
<Common request parameters>

{
    "InstanceId": "cmgo-igjy****",
    "KmsRegion": "ap-guangzhou",
    "KeyId": "AKID********************************"
}

Output Example

{
    "Response": {
        "FlowId": 17316505316,
        "RequestId": "a8dce7a4-d488-49c9-8d24-33cf623f5992"
    }
}

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
InternalError	Internal error
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.NotFoundInstance	The instance was not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud