調用ListSchemas查詢資料地圖資料庫模式列表-巨量資料開發治理平台 DataWorks-阿里雲

查詢資料地圖中給定資料庫或maxcompute專案下的模式列表，當前支援maxcompute和holo類型。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListSchemas

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ParentMetaEntityId	string	是	父層級實體 ID，可參考中繼資料實體相關概念說明，其中 holo 類型的`ParentMetaEntityId`可參考 ListDatabases 介面返回結果。 `ParentMetaEntityId`格式為`${EntityType}:${執行個體 ID 或轉義後的 URL}:${資料目錄標識}:${資料庫名稱}`，對於不存在的層級Null 字元佔位。說明對於 maxcompute 類型，執行個體 id 層級使用Null 字元佔位，資料庫名稱為 maxcompute 專案名稱，要求該專案已開啟三層模型。幾種常用類型 ParentMetaEntityId 格式參考如下 `maxcompute-project:::project_name` （要求該專案已開啟三層模型） `holo-database:instance_id::database_name` 說明其中 `instance_id`: holo 執行個體 ID `database_name`: 資料庫名稱 `project_name`: maxcompute 專案名	maxcompute-project:::project_name
Name	string	否	名稱，模糊比對。	abc
Comment	string	否	注釋，模糊比對。	test comment
Types	array	否	類型，精確匹配，為空白時查詢所有類型。
	string	否	模式類型。	MANAGED
SortBy	string	否	排序欄位，預設為 CreateTime，枚舉值，當前支援： CreateTime：建立時間。 ModifyTime：修改時間。 Name：名稱。 Type：類型。	CreateTime
Order	string	否	排序方向，預設為 Asc，枚舉值，當前支援： Asc：升序。 Desc：降序。	Asc
PageNumber	integer	否	分頁頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10，最大為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	235BBA5E-3428-XXXXXX
Success	boolean	請求是否成功。	true
PagingInfo	object	分頁資訊。
TotalCount	integer	總條數。	1
PageNumber	integer	頁碼。	1
PageSize	integer	分頁大小。	10
Schemas	array	資料庫 schema 列表。
	Schema	資料庫 schema。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "235BBA5E-3428-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Schemas": [
      {
        "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
        "Name": "test_db",
        "Comment": "test comment",
        "Type": "MANAGED",
        "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

錯誤碼

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

變更歷史

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