DescribeDBClusterTDE - PolarDB - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeDBClusterTDE	get	*dbcluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	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 for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.	Enabled
DBClusterId	string	The ID of the cluster.	pc-***************
EncryptNewTables	string	Indicates whether automatic encryption is enabled for new tables. Valid values: ON OFF Note This parameter is returned only for a PolarDB for MySQL cluster.	ON
EncryptionKey	string	The ID of the custom key.	2a4f4ac2-**---**********
RequestId	string	The ID of the request.	E37D1508-EC3B-4E06-A24A-C7AC31******
RotationInterval	string	The automatic key rotation period configured in Key Management Service (KMS). If no automatic key rotation period is configured, 0s is returned. Unit: seconds. For example, if the rotation period is set to 7 days, 604800s is returned. Note This parameter is returned only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster whose AutomaticRotation parameter is set to Enabled.	604800s
TDERegion	string	The region where the TDE key resides.	cn-beijing
TDEStatus	string	Indicates whether TDE encryption is enabled. Valid values: Enabled Disabled	Enabled

description

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details
2022-09-02	The Error code has changed. The response structure of the API has changed	View Change Details