DescribeDBInstanceTDEInfo_云数据库 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

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

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

流控信息

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

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dds:DescribeDBInstanceTDEInfo
Get
Instance
acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。

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

返回参数

字段名称字段详情
TDEStatusstring

TDE 状态,返回值为:展开详情

示例值:enabled
RequestIdstring

请求 ID。

示例值:F4DD0E29-361B-42F2-9301-B0048CCCE5D6
RoleARNstring

指定待授权角色的全局资源描述符 ARN(Alibaba Cloud Resource Name)信息。

示例值:acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKeystring

实例的自定义密钥。展开详情

示例值:2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
EncryptorNamestring

加密算法。

示例值:aes-256-cbc

返回示例

变更历史

变更时间变更内容概要操作
2023-10-19
变更返回参数

相关示例

查询MongoDB实例的透明数据加密TDE(Transparent Data Encryption)是否开启
2021-11-22