使用ListDatabases API查詢資料地圖資料庫列表-巨量資料開發治理平台 DataWorks-阿里雲

查詢資料地圖中給定執行個體/叢集/資料目錄下的資料庫列表。對於dlf/starrocks類型，查詢給定資料目錄下的資料庫列表，其中starocks類型僅支援查詢Internal Catalog；對於其他類型，查詢給定執行個體/叢集下的資料庫列表。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
對於 starrocks 類型，當前僅支援查詢 Internal catalog

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListDatabases

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ParentMetaEntityId	string	是	父層級實體 ID，可參考中繼資料實體相關概念說明。父層級實體類型參考 ListCrawlerTypes 介面若父層級實體為資料目錄，`ParentMetaEntityId`格式參考 ListCatalogs 介面返回結果。如果父層級實體為中繼資料採集器，`ParentMetaEntityId`格式為`${CrawlerType}:${執行個體 ID 或轉義後的 URL}`。幾種常用類型的 ParentMetaEntityId 格式參考如下： `dlf-catalog::catalog_id` `holo:instance_id` `mysql:(instance_id\|encoded_jdbc_url)` 說明其中 `catalog_id`: dlf 目錄 id。 `instance_id`: 執行個體 ID，對應資料來源以執行個體模式註冊時需要提供。 `encoded_jdbc_url`: JDBC 串連串的 URLEncode 編碼,對應資料來源以串連串方式註冊時需要提供。	holo:instance_id
Name	string	否	名稱，模糊比對。	test_tbl
Comment	string	否	注釋，模糊比對。	test comment
SortBy	string	否	排序欄位，預設為 CreateTime，枚舉值，當前支援： CreateTime：建立時間 ModifyTime：修改時間 Name：名稱	CreateTime
Order	string	否	排序方向，預設為 Asc，枚舉值，當前支援： Asc：升序 Desc：降序	Asc
PageNumber	integer	否	分頁頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10，最大為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	9DD08926-38B9-XXXXXXX
Success	boolean	請求是否成功。	true
PagingInfo	object	分頁結果。
TotalCount	integer	總條數。	1
PageNumber	integer	頁碼。	1
PageSize	integer	分頁大小。	10
Databases	array	資料庫列表。
	Database	資料庫資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9DD08926-38B9-XXXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Databases": [
      {
        "Id": "holo-database:h-xxxx::test_db",
        "Name": "test_db",
        "Comment": "test comment",
        "LocationUri": "oss://test-bucket/test_db",
        "ParentMetaEntityId": "holo:h-xxxx",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

錯誤碼

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

變更歷史

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