DescribeDatabases - 查詢資料庫列表 - ApsaraDB for OceanBase (Deprecated)

查詢租戶下的資料庫列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeDatabases

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
TenantId	string	否	租戶 ID。	t4pnum****
PageNumber	integer	否	分頁查詢的頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100 預設值：10	10
DatabaseName	string	否	資料庫名稱。不能使用某些預留關鍵字，如 test、mysql。	sms_pre
SearchKey	string	否	查詢列表的刪選關鍵字。	pay
WithTables	boolean	否	是否返回資料庫中的表資訊。預設值：false。說明如果表的數量過大則可能導致介面逾時。	true
InstanceId	string	否	叢集 ID。	ob****n0abo9uo

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
TotalCount	integer	租戶中的資料庫總數。	1
Databases	array<object>	租戶中的資料庫列表。
	array<object>	租戶中的資料庫列表。
Status	string	資料庫的狀態。 ONLINE: 運行中。 DELETING: 刪除中。	ONLINE
Description	string	資料庫的描述資訊。	test db
Encoding	string	資料庫的編碼。目前支援 utf8mb4、gbk 等編碼。	utf8mb4
DbType	string	資料庫類型。	mysql
DatabaseName	string	資料庫名稱。	sms_pre
CreateTime	string	建立時間。	2022-02-21 15:41:06
Users	array<object>	對該資料庫賦權的帳號列表資訊。
	object	對該資料庫賦權的帳號列表資訊。
UserType	string	帳號類型。 Admin：超級賬戶。 Normal：普通賬戶。	Normal
Role	string	帳號賦予該庫的角色許可權。對於 MySQL 模式，角色為資料庫（Database）層級，其有以下幾類： ReadWrite：讀寫權限，包括 ALL PRIVILEGES； ReadOnly：唯讀許可權，包括 SELECT； DDL: DDL 許可權，包括 CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW； DML: DML 許可權，包括 SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。	ReadOnly
UserName	string	帳號名稱。	user_pay_ro
Privileges	string	使用者授予資料庫自訂許可權時，privileges 返回自訂的許可權內容，以逗號 "," 分割；其餘時間 privileges 不返回資料。	select,delete,update
TenantId	string	租戶 ID。	t4pnum****
Tables	array<object>	資料庫表列表資訊。
	object	資料庫表列表資訊。
TableName	string	資料庫表名。	testTables
RequiredSize	number	所需容量，單位：GB。	5.67 GB
DataSize	number	實際資料大小，單位：GB。重要該欄位後期後台不再輸出, 請使用 RequiredSize。	5.67 GB
Collation	string	字元序。	utf8mb4_general_ci
InstanceId	string	所屬叢集 ID。	obsdh2f****
TenantName	string	租戶名。	tenantABC
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "Databases": [
    {
      "Status": "ONLINE",
      "Description": "test db",
      "Encoding": "utf8mb4",
      "DbType": "mysql",
      "DatabaseName": "sms_pre",
      "CreateTime": "2022-02-21 15:41:06",
      "Users": [
        {
          "UserType": "Normal",
          "Role": "ReadOnly",
          "UserName": "user_pay_ro",
          "Privileges": "select,delete,update"
        }
      ],
      "TenantId": "t4pnum****",
      "Tables": [
        {
          "TableName": "testTables"
        }
      ],
      "RequiredSize": 0,
      "DataSize": 0,
      "Collation": "utf8mb4_general_ci",
      "InstanceId": "obsdh2f****",
      "TenantName": "tenantABC"
    }
  ],
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

錯誤碼

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

變更歷史

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