修改MongoDB实例的透明数据加密TDE（Transparent Data Encryption）状态。
接口说明
透明数据加密 TDE（Transparent Data Encryption）可对数据文件执行实时 I/O 加密和解密，数据在写入磁盘之前进行加密，从磁盘读入内存时进行解密，更多详情请参见设置透明数据加密 TDE。
说明
TDE 功能开通后无法关闭。
调用本接口时，实例必须满足以下条件：
- 实例为副本集实例或分片集群实例。
- 实例的存储引擎为 WiredTiger。
- 实例的存储类型为本地盘版。
- 实例的数据库版本为 4.0 或 4.2 版本，如果实例数据库版本过低，您可以调用 UpgradeDBInstanceEngineVersion 接口升级数据库版本。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:ModifyDBInstanceTDE | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 | dds-bpxxxxxxxx |
| TDEStatus | string | 是 | TDE 状态，取值： enabled，即开启 TDE 功能。 说明
TDE 功能开启后不支持关闭，请谨慎开启。
| enabled |
| EncryptorName | string | 否 | 加密方式，取值：aes-256-cbc。 说明
当 TEDStatus 参数取值为 enabled 时，本参数才可用。
| aes-256-cbc |
| EncryptionKey | string | 否 | 自定义密钥 ID。 只有如下地域支持自定义密钥，其余地域会使用默认密钥加密。
| 749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| RoleARN | string | 否 | 指定角色的 ARN。格式： 说明
$accountID：云账号 ID。您可以通过登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击安全设置进行查看。$roleName：RAM 角色名称。您可以通过登录 RAM 控制台，单击左侧导航栏的 RAM 角色管理，在 RAM 角色名称列表下进行查看。 | acs:ram::123456789012****:role/adminrole |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | UnsupportedDBTdeStatus | Specified DB TDEStatus does not support this operation. | 指定实例已开启TDE，不支持此操作 |
| 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. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史