DescribeDBInstanceTDE - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the data encryption status of an instance.

Operation Description

This operation is used to view the Transparent Data Encryption (TDE) configuration of an instance.

The TDE feature is enabled for the instance by calling the ModifyDBInstanceTDE operation.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeDBInstanceTDE	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.	rm-uf6wjk5xxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
TDEStatus	string	The TDE status at the instance level. Valid values: Enabled and Disabled.	Enabled
RequestId	string	The ID of the request.	C816A4BF-A6EC-4722-95F9-2055859CCFD2
Databases	object []	The details of the TDE status at the database level. NoteFor the instances that run SQL Server 2019 SE or SQL Server EE, you can specify whether to enable TDE at the database level when you enable TDE at the instance level.
DBName	string	The name of the database.	test02
TDEStatus	string	The TDE status at the database level. Valid values: Enabled and Disabled.	Enabled

Examples

Sample success responses

JSONformat

{
  "TDEStatus": "Enabled",
  "RequestId": "C816A4BF-A6EC-4722-95F9-2055859CCFD2",
  "Databases": {
    "Database": [
      {
        "DBName": "test02",
        "TDEStatus": "Enabled"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Connect.Timeout	Service can not connect to instance temporarily.	The operation failed. The RDS instance cannot be connected. Please try again later.
400	SqlExcutionFailed	Failed to connect to host: connection timed out.	The connection to the host timed out.
400	DbossGeneralError	The instance is being created. Please wait.	The RDS instance is being created.
403	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.	The operation failed. The operation is not supported for the database engine of the RDS instance.
403	IncorrectEngineVersion	The engine version does not support the operation.	The operation failed. The operation is not supported for the database engine version of the RDS instance.
403	DBSizeExceeded	Exceeding the allowed DB size of DB instance.	The size of the database exceeds the maximum size that is allowed.
404	InvalidDBName.NotFound	Specified one or more DB name does not exist or DB status does not support.	The operation failed. The instance name cannot be found.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-10-28

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	Added Error Codes: 403
	Added Error Codes: 404

2022-06-23

API Description Update,The error codes of the API operation change.

Change item	Change content
API Description	API Description Update
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400

2021-10-19

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change