All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeDBInstanceTDEInfo

Last Updated:Jan 17, 2023

You can call this operation to query whether TDE is enabled for an ApsaraDB for MongoDB instance.

Operation Description

Note For more information about this function, see 131048Configure TDE.

Before you call this operation, make sure that the following requirements are met:

  • A replica set or sharded cluster instance is used.
  • The storage engine of the instance is WiredTiger.
  • The database engine version of the instance is 4.0 or 4.2. If the database engine version of your instance is earlier than 4.0, you can call UpgradeDBInstanceEngineVersion to upgrade the database engine.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:DescribeDBInstanceTDEInfo READ
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    without
without

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the Message Queue for Apache Kafka instance to be deleted.

dds-bpxxxxxxxx

Response parameters

Parameter Type Description Example
object
TDEStatus string

The TDE status. Valid values:

  • enabled
  • disabled
enabled
RequestId string

The ID of the request.

F4DD0E29-361B-42F2-9301-B0048CCCE5D6

Example

Normal return example

JSONFormat

{
  "TDEStatus": "enabled",
  "RequestId": "F4DD0E29-361B-42F2-9301-B0048CCCE5D6"
}

Error codes

For a list of error codes, visit the API error center.