DescribeDBInstanceTDEInfo - 查询MongoDB实例的透明数据加密TDE是否开启 - 云数据库 MongoDB

查询MongoDB实例的透明数据加密TDE（Transparent Data Encryption）是否开启。

接口说明

说明关于该功能的详细介绍，请参见设置透明数据加密 TDE。

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

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

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bpxxxxxxxx

返回参数

名称	类型	描述	示例值
	object
TDEStatus	string	TDE 状态，返回值为： enabled：开启状态。 disabled：关闭状态。说明当 TDK 状态为关闭时，不会返回 RoleARN、EncryptionKey 和 EncryptorName 参数。	enabled
RequestId	string	请求 ID。	F4DD0E29-361B-42F2-9301-B0048CCCE5D6
RoleARN	string	指定待授权角色的全局资源描述符 ARN（Alibaba Cloud Resource Name）信息。	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	实例的自定义密钥。目前仅以下地域支持 BYOK（Bring Your Own Key，用户可以自行管理和拥有加密密钥）：华东 1（杭州）华东 2（上海）华北 2（北京）华南 1（深圳）中国（香港）新加坡马来西亚（吉隆坡）说明支持 BYOK，用户可以管理且拥有密钥，系统将返回用户的自定义密钥；不支持 BYOK，用户不可管理密钥，系统将返回字符串`NoActiveBYOK`。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
EncryptorName	string	加密算法。	aes-256-cbc

示例

正常返回示例

JSON格式

{
  "TDEStatus": "enabled",
  "RequestId": "F4DD0E29-361B-42F2-9301-B0048CCCE5D6",
  "RoleARN": "acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "EncryptorName": "aes-256-cbc"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-10-19	OpenAPI 返回结构发生变更	查看变更详情