TDE Encryption Status Overview for MongoDB - ApsaraDB for MongoDB

Operation description

Note

For more information about TDE, see TDE.

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

The instance is a replica set or sharded cluster instance.
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 is earlier than 4.0, you can call the UpgradeDBInstanceEngineVersion operation to upgrade the database engine.

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

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 status. Valid values: enabled disabled	enabled
RequestId	string	The request ID.	F4DD0E29-361B-42F2-9301-B0048CCCE5D6
RoleARN	string	The Alibaba Cloud Resource Name (ARN) of the role to be authorized ARN information.	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	The customer-managed key for the instance. Currently, only the following regions support BYOK (Bring Your Own Key): 华东 1(杭州) 华东 2(上海) 华北 2(北京) 华南 1(深圳) China (Hong Kong) Singapore Malaysia (Kuala Lumpur) Note If Bring Your Own Key (BYOK) is supported, the custom key managed by the user is returned. If BYOK is not supported, the string `NoActiveBYOK` is returned.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
EncryptorName	string	加密算法.	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.