All Products
Search

This Product

    ApsaraDB for MongoDB:ModifyDBInstanceTDE

    Document Center

    ApsaraDB for MongoDB:ModifyDBInstanceTDE

    Last Updated:Jan 26, 2026

    Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.

    Operation description

    Transparent Data Encryption (TDE) provides real-time I/O encryption and decryption for data files. Data is encrypted before it is written to a disk and decrypted when it is read from the disk into memory. For more information, see Configure TDE.

    Note

    You cannot disable TDE after it is enabled.

    Before you call this operation, make sure that the instance meets the following requirements:

    • The instance is a replica set instance or a sharded cluster instance.

    • The instance uses the WiredTiger storage engine.

    • The instance uses local disks.

    • The instance runs MongoDB 4.0 or 4.2. If the instance runs an earlier version, you must upgrade the database version by calling the UpgradeDBInstanceEngineVersion operation.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:ModifyDBInstanceTDE

    update

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    The ID of the instance.

    dds-bpxxxxxxxx
    TDEStatus

    string

    Yes

    The TDE status. Set the value to enabled to enable TDE.

    Note

    You cannot disable TDE after you enable it. Enable this feature with caution.

    enabled
    EncryptorName

    string

    No

    The encryption method. Set the value to aes-256-cbc.

    Note

    This parameter is available only when TDEStatus is set to enabled.

    aes-256-cbc
    EncryptionKey

    string

    No

    The ID of the custom key. Custom keys are supported only in the following regions. In other regions, the default key is used.

    • Singapore (ap-southeast-1)

    • Hangzhou (cn-hangzhou)

    • Shanghai (cn-shanghai)

    • Beijing (cn-beijing)

    • Shenzhen (cn-shenzhen)

    • Hong Kong (cn-hongkong)

    • Malaysia (ap-southeast-3)

    749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    RoleARN

    string

    No

    The Alibaba Cloud Resource Name (ARN) of the RAM role. The format is acs:ram::$accountID:role/$roleName .

    Note

    • $accountID: The ID of your Alibaba Cloud account. To view the ID, log on to the Alibaba Cloud Management Console, move the pointer over your profile picture in the upper-right corner, and then click Security Settings.

    • $roleName: The name of the RAM role. To view the name, log on to the RAM console, click RAM Role Management in the navigation pane on the left, and then view the role name in the RAM Role Name list.

    acs:ram::123456789012****:role/adminrole

    SwitchMode

    string

    No

    Specifies when to enable TDE. Valid values:

    • 0: Enables TDE immediately.

    • 1: Enables TDE during the maintenance window.

    0

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    434D7127-6229-4355-BA50-7A3685A725DF

    Examples

    Success response

    JSON format

    {
  "RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 UnsupportedDBTdeStatus Specified DB TDEStatus does not support this operation.
    403 UnsupportedEngine Current DB Instance engine does not support this operation.
    403 IncorrectCharacterType Current DB instance CharacterType does not support this operation.
    403 IncorrectEngineVersion Current engine version does not support operations.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation.
    403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. The current database instance locking mode does not support this operation.
    404 InvalidClusterKms this cluster not kms service.
    404 InvalidParam Specified parameters is not valid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.