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

Note
  • Only ApsaraDB PolarDB MySQL-compatible edition 8.0 clusters support TDE.
  • After TDE is enabled, you cannot disable 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 ModifyDBClusterTDE

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

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

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

TDEStatus String Yes Enable

Modifies the TDE status. The value is set to Enable.

RoleArn String No acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole

The Alibaba Cloud Resource Name (ARN) of the role. An ARN is the global resource identifier of a role. For more information, see RAM role overview.

EncryptionKey String No 749c1df7-****-****-****-*********

The ID of the custom encryption key.

EncryptNewTables String No 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.

Response parameters

Parameter Type Example Description
RequestId String 5F859238-2A36-4A8D-BD0F-732112******

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

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

<ModifyDBClusterTDEResponse>
<requestId>5F859238-2A36-4A8D-BD0F-732112******</requestId>
</ModifyDBClusterTDEResponse>

JSON format

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

{
  "requestId" : "5F859238-2A36-4A8D-BD0F-732112******"
}

Error codes

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