Queries the Transparent Data Encryption (TDE) settings of a PolarDB for MySQL 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 parameter

Parameter Type Required Example Description
Action String Yes DescribeDBClusterTDE

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

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

The ID of the cluster.

Response parameters

Parameter Type Example Description
TDEStatus String Enabled

Indicates whether TDE encryption is enabled. Valid values:

  • Enabled
  • Disabled
RequestId String E37D1508-EC3B-4E06-A24A-C7AC31******

The ID of the request.

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

The ID of the cluster.

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

The ID of the custom key.

EncryptNewTables String ON

Indicates whether to enable automatic encryption for new tables. Valid values:

  • ON
  • OFF
TDERegion String cn-beijing

The region where the TDE key resides.

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>
    <TDERegion>cn-beijing</TDERegion>
</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",
  "TDERegion" : "cn-beijing"
}

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId does not exist.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId does not exist in the current record.

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