調用ListPartitions查詢資料地圖中資料表的分區列表-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
目前只支援 MaxCompute、HMS（EMR 叢集）類型的表。
呼叫本 API 前，請先呼叫 ListCrawlers 取得中繼資料採集器的 MetaEntityId，再呼叫 ListDatabases 取得資料庫 ID；對於啟用 Schema 的 MaxCompute 專案，繼續呼叫 ListSchemas 取得模式 ID；隨後呼叫 ListTables 取得 TableId，並將傳回的表 ID 傳入本 API。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListPartitions

list

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
TableId	string	是	所屬資料表 ID，可參考 ListTables 介面傳回結果，以及中繼資料實體相關概念說明。	maxcompute-table:::project_name:[schema_name]:table_name
Name	string	否	分割區名稱，模糊比對，該參數僅對 MaxCompute 類型有效。	ds=20250101
SortBy	string	否	排序欄位，預設為 CreateTime，列舉值，目前支援： CreateTime：建立時間，僅 MaxCompute 類型支援。 ModifyTime：修改時間，僅 MaxCompute 類型支援。 Name：名稱，HMS 類型使用的排序方式。 RecordCount：記錄數，僅 MaxCompute 類型支援。 DataSize：儲存容量，僅 MaxCompute 類型支援。枚舉值： ModifyTime : 修改時間，僅 MaxCompute 類型支援。 CreateTime : 建立時間，僅 MaxCompute 類型支援。 DataSize : 儲存容量，僅 MaxCompute 類型支援。 RecordCount : 記錄數，僅 MaxCompute 類型支援。 Name : 名稱，HMS 類型使用的排序方式。	CreateTime
Order	string	否	排序方向，預設為 Asc，列舉值，目前支援： Asc：遞增。 Desc：遞減。枚舉值： Asc : 遞增。 Desc : 遞減。	Asc
PageNumber	integer	否	分頁頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10，最大為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	傳回結果。
RequestId	string	請求 ID。	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	請求是否成功。	true
PagingInfo	object	分頁結果。
TotalCount	integer	總記錄數。	1
PageNumber	integer	分頁頁碼。	1
PageSize	integer	分頁大小。	10
PartitionList	array	資料表的分割區清單。
	Partition	資料表的分割區。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "PartitionList": [
      {
        "TableId": "maxcompute-table:accountId::project::table",
        "Name": "ds=20250101",
        "CreateTime": 1700192563000,
        "ModifyTime": 1700192563000,
        "RecordCount": 1000000,
        "DataSize": 4096
      }
    ]
  }
}

錯誤碼

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

變更歷史

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