All Products
Search
Document Center

PolarDB:DescribeDBClusterTDE

Last Updated:Aug 06, 2025

Queries the details of the transparent data encryption (TDE) settings for a specified PolarDB cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBClusterTDE

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

The cluster ID.

pc-***************

description

Response parameters

Parameter

Type

Description

Example

object

AutomaticRotation

string

Indicates whether automatic key rotation is allowed. Valid values:

  • Enabled: Automatic key rotation is allowed.

  • Disabled: Automatic key rotation is not allowed.

Note

This parameter is returned only when the database engine is compatible with PostgreSQL or Oracle syntax.

Enabled

DBClusterId

string

The unique ID of the cluster.

pc-***************

EncryptNewTables

string

Indicates whether automatic encryption is enabled for all newly created tables. Valid values:

  • ON: Automatic encryption is enabled.

  • OFF: Automatic encryption is disabled.

Note

This parameter is returned only when the database engine is compatible with MySQL.

ON

EncryptionKey

string

The ID of the custom key.

2a4f4ac2-****-****-****-************

RequestId

string

The unique ID of the request.

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

RotationInterval

string

The automatic key rotation interval configured in KMS. If no automatic key rotation interval is set, 0 s is returned. Unit: s.

For example, if the rotation interval is 7 days, 604800 s is returned.

Note

This parameter is returned only when the database engine is compatible with PostgreSQL or Oracle syntax, and the value of AutomaticRotation is Enabled.

604800s

TDERegion

string

The region where the TDE key is located.

cn-beijing

TDEStatus

string

Indicates whether TDE encryption is enabled. Valid values:

  • Enabled: TDE encryption is enabled.

  • Disabled: TDE encryption is disabled.

Enabled

EncryptionKeyStatus

string

The status of the key. Valid values:

  • Enabled: The key is enabled.

  • Disabled: The key is disabled.

Enabled

description

Examples

Success response

JSON format

{ "AutomaticRotation": "Enabled", "DBClusterId": "pc-***************", "EncryptNewTables": "ON", "EncryptionKey": "2a4f4ac2-****-****-****-************", "RequestId": "E37D1508-EC3B-4E06-A24A-C7AC31******", "RotationInterval": "604800s", "TDERegion": "cn-beijing", "TDEStatus": "Enabled", "EncryptionKeyStatus": "Enabled" }

Error codes

HTTP status code

Error code

Error message

Description

404

InvalidDBCluster.NotFound

The DBClusterId provided does not exist in our records.

The specified DBClusterId parameter does not exist in the current record.

404

InvalidDBClusterId.NotFound

The DBClusterId provided does not exist in our records.

The specified DBClusterId parameter does not exist in the current record.

404

InvalidDBClusterId.Malformed

The specified parameter DBClusterId is not valid.

The specified DBClusterId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.