Queries the Transparent Data Encryption (TDE) settings of a ApsaraDB PolarDB MySQL-compatible edition cluster.

Note Only ApsaraDB PolarDB MySQL-compatible edition 8.0 clusters support TDE.

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.

Response parameters

Parameter Type Example Description
TDEStatus String Enabled

Specifies whether TDE encryption is enabled. Valid values:

  • Enabled: TDE encryption is enabled.
  • Disabled: TDE encryption is disabled.
RequestId String E37D1508-EC3B-4E06-A24A-C7AC31******

The ID of the request.

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

The ID of the PolarDB cluster.

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

The ID of the custom encryption key.

EncryptNewTables String ON

Specifies whether automatic encryption is enabled for new tables. Valid values:

  • ON: Automatic encryption is enabled for new tables.
  • OFF: Automatic encryption is disabled for new tables.

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeDBClusterTDEResponse>
    <TDEStatus>Enabled</TDEStatus>
    <RequestId>E37D1508-EC3B-4E06-A24A-C7AC31******</RequestId>
    <DBClusterId>pc-***************</DBClusterId>
    <EncryptionKey>2a4f4ac2-****-****-****-************</EncryptionKey>
    <EncryptNewTables>ON</EncryptNewTables>
</DescribeDBClusterTDEResponse>

JSON format

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

{
  "TDEStatus" : "Enabled",
  "RequestId" : "E37D1508-EC3B-4E06-A24A-C7AC31******",
  "DBClusterId" : "pc-***************",
  "EncryptionKey" : "2a4f4ac2-****-****-****-************",
  "EncryptNewTables" : "ON"
}

Error codes

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