Queries the Transparent Data Encryption (TDE) settings of a PolarDB cluster.

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 No DescribeDBClusterTDE

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

DBClusterId String Yes pc-***************

The ID of the PolarDB cluster that you want to manage.

Response parameters

Parameter Type Example Description
DBClusterId String pc-***************

The ID of the PolarDB cluster.

EncryptionKey String 2a4f4ac2-****-****-****-************

The ID of the encryption key.

RequestId String E37D1508-EC3B-4E06-A24A-C7AC31******

The ID of the request.

TDEStatus String Enabled

The TDE status. Valid values:

  • Enabled: TDE is enabled.
  • Disabled: TDE is disabled.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=DescribeDBClusterTDE
&DBClusterId=pc-***************
&<Common request parameters>

Sample success responses

XML format

<DescribeDBClusterTDEResponse>
  <TDEStatus>Enabled</TDEStatus>
  <RequestId>312C2B76-A039-4AF2-856B-3815EF******</RequestId>
  <DBClusterId>pc-***************</DBClusterId>
  <EncryptionKey>2a4f4ac2-****-****-****-************</EncryptionKey>
</DescribeDBClusterTDEResponse>

JSON format

{
	"TDEStatus": "Enabled",
	"RequestId": "312C2B76-A039-4AF2-856B-3815EF******",
	"DBClusterId": "pc-***************",
	"EncryptionKey": "2a4f4ac2-****-****-****-************"
}

Error codes

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