全部产品
Search

搜索本产品

    云原生数据库 PolarDB：ModifyDBClusterTDE - 开启PolarDB TDE功能

    文档中心

    云原生数据库 PolarDB：ModifyDBClusterTDE - 开启PolarDB TDE功能

    更新时间：Sep 27, 2024

    ModifyDBClusterTDE

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    集群 ID。

    		pc-************
    TDEStatusstring是

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

    		Enable
    RoleArnstring否

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

    		acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole
    EncryptionKeystring否

    自定义密钥 ID。

    		749c1df7-****-****-****-*********
    EncryptNewTablesstring否

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

    • ON：开启

    • OFF：关闭

    		ON

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		5F859238-2A36-4A8D-BD0F-732112******

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更查看变更详情
    2022-09-28OpenAPI 错误码发生变更查看变更详情
    2021-06-15OpenAPI 错误码发生变更查看变更详情