使用DescribeDBInstanceTDEInfo查詢MongoDB執行個體的透明資料加密TDE狀態-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

介面說明

說明

關於該功能的詳細介紹，請參見設定透明資料加密 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：關閉狀態。說明當 TDE 狀態為關閉時，不會返回 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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。