DescribeTenants - 查詢叢集下的租戶列表資訊 - ApsaraDB for OceanBase (Deprecated)

查詢指定 OceanBase 叢集列表下的租戶列表資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeTenants

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	Oceanbase 叢集 ID。	ob317v4uif****
TenantName	string	否	租戶名稱。長度為 2~20 個字元，支援英文字母、數字和底線，區分大小寫，必須以字母或底線開頭。不可設定為 sys。	pay_online
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100 預設值：10	10
PageNumber	integer	否	分頁查詢的頁碼。起始值：1。預設值：1。	1
TenantId	string	否	租戶 ID。	ob2mr3oae0****
SearchKey	string	否	查詢列表的篩選關鍵字。	pay

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
TotalCount	integer	查詢到的指定 OceanBase 叢集的租戶總數。	1
RequestId	string	請求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Tenants	array<object>	租戶的列表資訊。
	object	租戶的列表資訊。
VpcId	string	Virtual Private Cloud ID。如無合適的 VPC，請根據頁面提示建立一個 VPC，詳情參見什麼是專用網路。	vpc-bp1d2q3mhg9i23ofi****
Status	string	租戶的狀態。 PENDING_CREATE: 建立中 RESTORE: 恢複中 ONLINE: 運行中 SPEC_MODIFYING: 規格修改中 ALLOCATING_INTERNET_ADDRESS: 公網地址分配中 PENDING_OFFLINE_INTERNET_ADDRESS: 公網地址關閉中 PRIMARY_ZONE_MODIFYING: 切主可用性區域中 PARAMETER_MODIFYING: 參數修改中 WHITE_LIST_MODIFYING: 白名單修改中	ONLINE
PrimaryZone	string	租戶的主可用性區域。	cn-hangzhou-i
DeployType	string	租戶的部署類型。 multiple：多機房 single：單機房 dual：雙機房	multiple
DeployMode	string	租戶的資料副本模式。對於高可用版本：三地區為 N-N-N，兩可用性區域和單可用性區域均為 N-N；對於基礎版為 N。說明其中，N 為單可用性區域內的節點數。	1-1-1
CreateTime	string	租戶的建立時間。	2021-09-17 15:52:17.0
TenantName	string	租戶名稱。	pay_online
Mem	integer	租戶總的記憶體大小，單位：GB。	20
Cpu	integer	租戶總的 CPU 核心數，單位：Core。	10
Description	string	租戶描述資訊。	paycore database
TenantMode	string	租戶模式。當前支援： Oracle：Oracle 模式； MySQL: MySQL 模式。	Oracle
TenantId	string	租戶 ID。	t33h8y08k****
UnitCpu	integer	租戶每個 Unit 的 CPU 核心數，單位：Core。	5
UnitMem	integer	租戶每個 Unit 的記憶體大小，單位：GB。	10
UnitNum	integer	租戶的 unit 個數。	2
UsedDiskSize	number	租戶已使用磁碟量。	10
Charset	string	字元集	utf8mb4
Collation	string	字元序	utf8mb4_general_ci
EnableReadOnlyReplica	boolean
ParameterTemplate	string	參數模板	express_oltp
Iops	integer		10000

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Tenants": [
    {
      "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
      "Status": "ONLINE",
      "PrimaryZone": "cn-hangzhou-i",
      "DeployType": "multiple",
      "DeployMode": "1-1-1",
      "CreateTime": "2021-09-17 15:52:17.0",
      "TenantName": "pay_online",
      "Mem": 20,
      "Cpu": 10,
      "Description": "paycore database",
      "TenantMode": "Oracle",
      "TenantId": "t33h8y08k****",
      "UnitCpu": 5,
      "UnitMem": 10,
      "UnitNum": 2,
      "UsedDiskSize": 10,
      "Charset": "utf8mb4",
      "Collation": "utf8mb4_general_ci",
      "EnableReadOnlyReplica": true,
      "ParameterTemplate": "express_oltp",
      "Iops": 10000
    }
  ]
}

錯誤碼

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

變更歷史

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