调用ModifyDBClusterTDE开启TDE功能-云原生数据库 PolarDB-阿里云

ModifyDBClusterTDE

接口说明

说明

该操作需要先开通 KMS。具体操作请参见购买专属 KMS 实例。

TDE 加密开启后无法关闭。

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作	访问级别	资源类型	条件关键字	关联操作
polardb:ModifyDBClusterTDE	update	*DBCluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}`	无	无

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-************
TDEStatus	string	是	修改 TDE 状态。取值固定为 Enable。	Enable
RoleArn	string	否	角色的全局资源描述符，用来指定具体角色。详情请参见 RAM 角色概览。	acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	否	自定义密钥 ID。	749c1df7-**---*******
EncryptNewTables	string	否	是否开启自动加密所有新建的表。取值： ON：开启 OFF：关闭说明仅当数据库引擎为 MySQL 兼容时，该参数生效。	ON
EnableAutomaticRotation	string	否	是否允许实例 TDE 密钥在检测到 KMS 密钥版本变更时，于轮转周期后最近的运维时间进行自动轮转。仅自定义密钥支持该参数。 true：允许 false：不允许说明仅当数据库引擎为 PostgreSQL 兼容或 Oracle 语法兼容时，支持该参数。	false

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	5F859238-2A36-4A8D-BD0F-732112******

正常返回示例

JSON格式

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

HTTP status code	错误码	错误信息	描述
400	InvalidTDEStatus.AlreadyEnabled	TDE has already enabled in the this cluster.	操作失败，此集群已开通TDE。
400	InvalidDBType.Malformed	The Specified DBType is not valid.	指定的数据库类型无效.
400	InvalidTDEEnabledType.Malformed	The specified parameter TDEStatus is not valid.	指定的参数TDEStatus无效
400	InvalidAutoTableTransparentEncryption.Malformed	The specified AutoTableTransparentEncryption is not valid.	指定的参数AutoTableTransparentEncryption无效。
403	UnsupportedKmsService.NotEnabled	KMS service is not enabled.	未启用KMS服务。
403	OperationDenied.DBNodeType	The operation is not permitted due to type of node.	操作失败，节点类型不允许此操作。
403	IncorrectGdnState	db instance %s status is not available:%s.	实例 %s 状态是无用的：%s。
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效

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