文档

ModifyInstanceTDE - 开启透明数据加密TDE

更新时间:

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:ModifyInstanceTDEWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
  • kvstore:TDEStatus

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****
TDEStatusstring

开启 TDE 功能,取值:Enabled

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

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

说明 TDEStatus 参数取值为 Enabled 时,本参数才可用。
AES-CTR-256
EncryptionKeystring

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

说明
  • 如果不传入本参数,则由密钥管理服务自动生成密钥。
  • 如需创建自定义密钥,您可以调用密钥管理服务的 CreateKey 接口。
  • ad463061-992d-4195-8a94-ed63********
    RoleArnstring

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

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    5D622714-AEDD-4609-9167-F5DDD3D1****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息
    400InvalidInstanceName.MalformedThe Specified parameter InstanceName is not valid.
    400TaskExistsSpecified task have existed.

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

    变更历史

    变更时间变更内容概要操作
    2023-09-14OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-03-02OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400