DescribeTenantEncryption - 查詢租戶加密資訊 - ApsaraDB for OceanBase (Deprecated)

該介面用於查詢租戶加密資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeTenantEncryption

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
TenantId	string	否	租戶 ID。	t4louaeei****
TenantName	string	否	租戶名稱。長度為 2~20 個字元，支援英文字母、數字和底線，區分大小寫，必須以字母或底線開頭。不可設定為 sys。	forMySQLTenant
PageNumber	integer	否	分頁查詢的頁碼。起始值：1 預設值：1	1
PageSize	integer	否	每頁顯示條數，預設為 10。	10

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
RequestId	string	請求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TotalCount	integer	總數，分頁查詢時生效。	8
TenantEncryptions	array<object>	允許加密的情境列表資訊。
	object	允許加密的情境列表。
TenantId	string	租戶 ID。	t4louaeei****
TenantMode	string	租戶模式。當前支援： Oracle：Oracle 模式。 MySQL: MySQL 模式。	MySQL
TenantName	string	租戶名稱。	forMySQLTenant
EnableEncryption	boolean	是否啟用加密。取值： true false	false
TenantStatus	string	租戶狀態。	ONLINE
Status	string	租戶是否開啟加密的狀態。	OPEN
EncryptionType	string	加密的類型。	INTERNAL
EncryptionKeyId	string	kms 加密的 keyId。	xxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 8,
  "TenantEncryptions": [
    {
      "TenantId": "t4louaeei****",
      "TenantMode": "MySQL",
      "TenantName": "forMySQLTenant",
      "EnableEncryption": false,
      "TenantStatus": "ONLINE",
      "Status": "OPEN",
      "EncryptionType": "INTERNAL",
      "EncryptionKeyId": "xxx"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	The request processing has failed due to some unknown error.	內部錯誤

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

變更歷史

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