Queries the data encryption status of an instance.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBInstanceTDE

The operation that you want to perform. Set the value to DescribeDBInstanceTDE.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

Response parameters

Parameter Type Example Description
TDEStatus String Enabled

The TDE status at the instance level. Valid values: Enabled and Disabled.

RequestId String C816A4BF-A6EC-4722-95F9-2055859CCFD2

The ID of the request.

Databases Array of Database

The details of the TDE status at the database level.

Note If your instance runs 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.
Database
DBName String test02

The name of the database.

TDEStatus String Enabled

The TDE status at the database level. Valid values: Enabled and Disabled.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceTDE
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeDBInstanceTDEResponse>
	<TDEStatus>Enabled</TDEStatus>
	<Databases>
		<DBName>test02</DBName>
		<TDEStatus>Enabled</TDEStatus>
	</Databases>
	<requestId>C816A4BF-A6EC-4722-95F9-2055859CCFD2</requestId>
</DescribeDBInstanceTDEResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

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

For a list of error codes, visit the API Error Center.