查詢租戶下的數據庫列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| oceanbase:DescribeDatabases | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TenantId | string | 是 | 租戶 ID。 | t4pnum**** |
| PageNumber | integer | 否 | 分頁查詢的頁碼。
| 1 |
| PageSize | integer | 否 | 分頁查詢時設置的每頁行數。
| 10 |
| DatabaseName | string | 否 | 數據庫名稱。 不能使用某些預留關鍵字，如 test、mysql。 | sms_pre |
| SearchKey | string | 否 | 查詢列表的刪選關鍵字。 | pay |
| WithTables | boolean | 否 | 是否返回數據庫中的表信息。 說明
如果表的數量過大則可能導致接口超時。
| true |
| InstanceId | string | 否 | 集群 ID。 | ob****n0abo9uo |
返回參數
示例
正常返回示例
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"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-10-30 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-07-04 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2022-09-28 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2022-01-17 | OpenAPI 返回結構發生變更 | 查看變更詳情 |