Queries whether Transparent Data Encryption (TDE) is enabled for a PolarDB-X instance.

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.

DBInstanceName String No pxc-********

The ID of the instance.

RegionId String No cn-hangzhou

The region ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

The ID of the request.

Data Object

The returned data.

TDEStatus String 0

Indicates whether TDE is enabled for the instance. Valid values:

  • 0: disabled
  • 1: enabled

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstanceTDE
&DBInstanceName=pxc-********
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeDBInstanceTDEResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Data>
        <TDEStatus>0</TDEStatus>
    </Data>
</DescribeDBInstanceTDEResponse>

JSON format 

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

{
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data" : {
    "TDEStatus" : "0"
  }
}

Error codes

HttpCode Error code Error message Description
403 IncorrectEngineVersion The current engine version does not support the operation. The error message returned because the engine version of the specified PolarDB-X instance does not support this operation.

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