通過 ListDatasets API 查詢資料集 - DataWorks

查詢資料集列表，當前支援DataWorks資料集與PAI資料集。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListDatasets

list

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	否	DataWorks 工作空間 ID	251363
Origin	string	否	資料集來源，取值有 DataWorks PAI	DataWorks
Name	string	否	資料集名稱，支援模糊搜尋	test_dataset
DataTypeList	array	否	資料類型，可多選，當前支援 COMMON 通用 PIC 圖片 TEXT 文本 TABLE 表格 VIDEO 視頻 AUDIO 音頻 INDEX 索引
	string	否	資料類型枚舉值： TABLE : 表格 VIDEO : 視頻 COMMON : 通用 TEXT : 文本 PIC : 圖片 INDEX : 索引 AUDIO : 音頻	COMMON
StorageTypeList	array	否	儲存類型，可多選，當前支援 OSS Object Storage Service NAS 通用型 NAS 檔案儲存體 EXTREMENAS 極速型 NAS 檔案儲存體 DLF_LANCE 資料湖構建 CPFS CPFS 檔案儲存體 BMCPFS 智算 CPFS 檔案儲存體 MAXCOMPUTE MaxCompute 表枚舉值： NAS : 通用型 NAS 檔案儲存體 MAXCOMPUTE : MaxCompute 表 CPFS : CPFS 檔案儲存體 BMCPFS : 智算 CPFS 檔案儲存體 EXTREMENAS : 極速型 NAS 檔案儲存體 OSS : Object Storage Service DLF_LANCE : 資料湖構建
	string	否	儲存類型	NAS
CreatorId	string	否	建立者 ID	12103XXX46492139
SortBy	string	否	排序欄位，預設為 CreateTime(建立時間) 枚舉值： ModifyTime : 修改時間 CreateTime : 建立時間 Name : 名稱	CreateTime
Order	string	否	排序方向，預設為 Desc（降序）枚舉值： Asc : 升序 Desc : 降序	Asc
PageNumber	integer	否	分頁頁碼，預設為 1	1
PageSize	integer	否	分頁大小，預設為 10，最大 100	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	RequestId	6A6CBE87-9F91-1323-B680-E7A7065XXXXX
Success	boolean	請求是否成功	true
PagingInfo	object	分頁資訊
TotalCount	integer	總數	100
PageNumber	integer	分頁頁碼	1
PageSize	integer	分頁大小	10
Datasets	array	資料集列表
	Dataset	資料集對象

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX\n",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Datasets": [
      {
        "Id": "dataworks-dataset:1gxxxqjx155usz3hrv",
        "Name": "test_dataset",
        "Comment": "測試資料集",
        "ProjectId": 123456,
        "Origin": "DataWorks",
        "DataType": "COMMON",
        "StorageType": "OSS",
        "CreatorId": "210484359",
        "Readme": "## introduction",
        "LatestVersion": {
          "Id": "dataworks-datasetVersion:0gfxxxjx155usz3hrv:1",
          "DatasetId": "dataworks-datasetVersion:0gfxxxjx155usz3hrv",
          "Comment": "初始版本",
          "CreatorId": "17815XXX61016173",
          "VersionNumber": 1,
          "StorageType": "OSS",
          "Url": "oss://test-oss-bucket/test_dir/",
          "MountPath": "/mnt/data",
          "CreateTime": 1736756055000,
          "ModifyTime": 1736756055000,
          "Labels": [
            {
              "Key": "key1",
              "Value": "value1"
            }
          ],
          "ImportInfo": {
            "key": "None"
          }
        },
        "CreateTime": 1736756055000,
        "ModifyTime": 1736756055000,
        "Labels": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

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