调用ModifyInstanceTDE为Redis实例开启透明数据加密TDE功能,支持自定义密钥。

说明 关于透明数据加密TDE(Transparent Data Encryption)的详细介绍及开启后的影响,请参见开启透明数据加密TDE

调试

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

请求参数

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

系统规定参数,取值:ModifyInstanceTDE

InstanceId String r-bp1zxszhcgatnx****

实例ID,可调用DescribeInstances获取。

TDEStatus String Enabled

开启TDE功能,取值:Enabled

说明 TDE功能开启后暂不支持关闭,开启前请评估是否影响业务。更多信息,请参见开启透明数据加密TDE
RegionId String cn-hangzhou

实例所属地域的ID,您可以调用DescribeInstanceAttribute接口查询。

EncryptionName String AES-CTR-256

加密算法,默认AES-CTR-256。

说明TDEStatus参数取值为Enabled时,本参数才可用。
EncryptionKey String ad463061-992d-4195-8a94-ed63********

自定义密钥ID,您可以调用DescribeEncryptionKeyList获取。

说明
  • 如果不传入本参数,则由密钥管理服务自动生成密钥。
  • 如需创建自定义密钥,您可以调用密钥管理服务的CreateKey接口。
RoleArn String acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

指定待授权角色的全局资源描述符ARN(Alibaba Cloud Resource Name)信息,完成授权后即可使用相关密钥管理服务,格式:acs:ram::$accountID:role/$roleName

说明
  • $accountID:云账号ID。您可以登录阿里云控制台,将鼠标悬停在右上角头像的位置,单击安全设置进行查看。
  • $roleName:RAM角色名称,取值固定为:AliyunRdsInstanceEncryptionDefaultRole

返回数据

名称 类型 示例值 描述
RequestId String 5D622714-AEDD-4609-9167-F5DDD3D1****

请求ID。

示例

请求示例

http(s)://r-kvstore.aliyuncs.com/?Action=ModifyInstanceTDE
&InstanceId=r-bp1zxszhcgatnx****
&TDEStatus=Enabled
&<公共请求参数>

正常返回示例

XML格式

<ModifyInstanceTDEResponse>
	  <RequestId>5D622714-AEDD-4609-9167-F5DDD3D1****</RequestId>
</ModifyInstanceTDEResponse>

JSON格式

{"RequestId":"5D622714-AEDD-4609-9167-F5DDD3D1****"}

错误码

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