ModifyDBInstanceTDE_云数据库 MongoDB 版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

透明数据加密 TDE(Transparent Data Encryption)可对数据文件执行实时 I/O 加密和解密,数据在写入磁盘之前进行加密,从磁盘读入内存时进行解密,更多详情请参见设置透明数据加密 TDE

说明 TDE 功能开通后无法关闭。

调用本接口时,实例必须满足以下条件:

  • 实例为副本集实例或分片集群实例。
  • 实例的存储引擎为 WiredTiger。
  • 实例的存储类型为本地盘版。
  • 实例的数据库版本为 4.0 或 4.2 版本,如果实例数据库版本过低,您可以调用 UpgradeDBInstanceEngineVersion 接口升级数据库版本。

流控信息

请求速率为200/1(s)。更多流控信息,请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。

示例值:dds-bpxxxxxxxx参考取值来源:
    CreateDBInstance
    DescribeDBInstances
TDEStatusstring

TDE 状态,取值: enabled,即开启 TDE 功能。展开详情

示例值:enabled
EncryptorNamestring

加密方式,取值:aes-256-cbc展开详情

示例值:aes-256-cbc
EncryptionKeystring

自定义密钥 ID。展开详情

示例值:749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx参考取值来源:
    DescribeDBInstanceEncryptionKey
RoleARNstring

指定角色的 ARN。格式:acs:ram::$accountID:role/$roleName 展开详情

示例值:acs:ram::123456789012****:role/adminrole

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:434D7127-6229-4355-BA50-7A3685A725DF

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
UnsupportedDBTdeStatus
Specified DB TDEStatus does not support this operation.诊断
403
UnsupportedEngine
Current DB Instance engine does not support this operation.诊断
403
IncorrectCharacterType
Current DB instance CharacterType does not support this operation.诊断
403
IncorrectEngineVersion
Current engine version does not support operations.诊断
403
IncorrectDBInstanceState
Current DB instance state does not support this operation.诊断
403
IncorrectDBInstanceLockMode
Current DB instance lock mode does not support this operation.诊断
404
InvalidClusterKms
this cluster not kms service.诊断
404
InvalidParam
Specified parameters is not valid.诊断

变更历史

变更时间变更内容概要操作
2023-01-05
新增返回参数

相关示例

修改MongoDB实例的透明数据加密TDE(Transparent Data Encryption)状态
2021-11-19