调用ModifyDBClusterTDE接口开启PolarDB MySQL引擎集群的TDE功能或修改加密方式。

说明
  • 该操作需要先开通KMS。具体操作请参见购买专属KMS实例
  • TDE加密开启后无法关闭。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDBClusterTDE

系统规定参数。取值:ModifyDBClusterTDE

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

集群ID。

TDEStatus String Enable

修改TDE状态。取值固定为Enable

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

角色的全局资源描述符,用来指定具体角色。详情请参见RAM角色概览

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

自定义密钥ID。

EncryptNewTables String ON

是否开启自动加密所有新建的表。取值:

  • ON:开启
  • OFF:关闭

返回数据

名称 类型 示例值 描述
RequestId String 5F859238-2A36-4A8D-BD0F-732112******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterTDE
&DBClusterId=pc-************
&TDEStatus=Enable
&<公共请求参数>

正常返回示例

XML格式

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

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

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTDEStatus.AlreadyEnabled TDE has already enabled in the this cluster. 操作失败,此集群已开通TDE。
400 InvalidDBType.Malformed The Specified DBType is not valid. 指定的数据库类型无效.
403 UnsupportedKmsService.NotEnabled KMS service is not enabled. 未启用KMS服务。
403 OperationDenied.DBNodeType The operation is not permitted due to type of node. 操作失败,节点类型不允许此操作。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

访问错误中心查看更多错误码。