All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeDBInstanceTDEInfo

    Document Center

    ApsaraDB for MongoDB:DescribeDBInstanceTDEInfo

    Last Updated:Jun 26, 2026

    Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.

    Operation description

    Note

    For more information about this feature, see Settings for transparent data encryption TDE.

    When you invoke this operation, the instance must meet the following conditions:

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

    • The storage DPI engine of the instance is WiredTiger.

    • The database DPI engine version of the instance is 4.0 or 4.2. If the database DPI engine version is earlier than the required version, you can invoke the UpgradeDBInstanceEngineVersion operation to upgrade the database DPI engine version.

    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:DescribeDBInstanceTDEInfo

    get

    *Instance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    The instance ID.

    dds-bpxxxxxxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    TDEStatus

    string

    The TDE enabling status. Valid values:

    • enabled: TDE is enabled.

    • disabled: TDE is disabled.

    Note

    If the TDE status is disabled, the RoleARN, EncryptionKey, and EncryptorName parameters are not returned.

    enabled
    RequestId

    string

    The request ID.

    F4DD0E29-361B-42F2-9301-B0048CCCE5D6
    RoleARN

    string

    The global resource descriptor ARN (Alibaba Cloud Resource Name) of the role pending authorization.

    acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
    EncryptionKey

    string

    The custom key of the instance.

    Currently, only the following regions support Bring Your Own Key (BYOK), which allows you to manage and own encryption keys:

    • China (Hangzhou)

    • China (Shanghai)

    • China (Beijing)

    • China (Shenzhen)

    • Hong Kong (China)

    • Singapore

    • Malaysia (Kuala Lumpur)

    Note

    If BYOK is supported, you can manage and own the key, and the system returns your custom key. If BYOK is not supported, you cannot manage the key, and the system returns the string NoActiveBYOK.

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    EncryptorName

    string

    The encryption algorithm.

    aes-256-cbc

    Examples

    Success response

    JSON format

    {
  "TDEStatus": "enabled",
  "RequestId": "F4DD0E29-361B-42F2-9301-B0048CCCE5D6",
  "RoleARN": "acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "EncryptorName": "aes-256-cbc"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.