調用ListDatasets API擷取資料集列表-人工智慧平台 PAI-阿里雲

擷取某個工作空間下的資料集列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

paidataset:ListDatasets

list

*全部資源

*

無

請求文法

GET /api/v1/datasets HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	資料集列表的頁碼。起始值為 1，預設為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。預設為 10。	10
Order	string	否	分頁查詢時，對指定的排序欄位進行升序或降序。預設值為 ASC。 ASC：升序。 DESC：降序。枚舉值： ASC : ASC DESC : DESC	ASC
Name	string	否	資料集名稱，支援根據資料集名稱模糊搜尋。	myName
Properties	string	否	資料集屬性，多項之間使用半形逗號（,）分隔。支援以下取值： DIRECTORY：檔案夾。 FILE：檔案。枚舉值： DIRECTORY : DIRECTORY FILE : FILE	FILE
DataSourceTypes	string	否	資料來源類型，多項之間使用半形逗號分隔。支援以下取值： NAS：資料存放區為阿里雲Apsara File Storage NAS。 OSS：資料存放區為阿里雲Object Storage Service。枚舉值： NAS : NAS OSS : OSS	OSS
DataTypes	string	否	資料集的資料類型，多項之間使用半形逗號（,）分隔。支援以下取值： VIDEO：視頻。 COMMON：通用。 TEXT：文本。 PIC：圖片。 AUDIO：音頻。枚舉值： VIDEO : VIDEO COMMON : COMMON TEXT : TEXT PIC : PIC AUDIO : AUDIO	COMMON,TEXT
SourceId	string	否	資料來源 ID。當 SourceTypes 為 USER 時，SourceId 支援自訂。當 SourceTypes 為 ITAG 時，即 iTAG 模組標註結果產生的資料集時，SourceId 為 ITAG 的任務 ID。當 SourceTypes 為 PAI_PUBLIC_DATASET 時，即使用 PAI 公用資料集建立的資料集時，SourceId 預設為空白。	d-rbvg5wzljzjhc9ks92
SourceTypes	string	否	來源類型，多項之間使用半形逗號分隔。枚舉值： PAI_PUBLIC_DATASET : PAI_PUBLIC_DATASET ITAG : ITAG USER : USER	USER,ITAG
WorkspaceId	string	否	資料集所在工作空間 ID。如何擷取工作空間 ID，請參見 ListWorkspaces 。如果不配置該參數，則會使用預設工作空間；如果預設工作空間不存在，則會報錯。	324**
Label	string	否	資料集標籤，用於過濾資料集列表。標籤 Key 或 Value 中，有指定字串的，都會被過濾出來。	test
Provider	string	否	資料集提供方。傳回值為"pai"時表示該資料集為 PAI 平台的公用資料集。	pai
SourceDatasetId	string	否	iTag 標註集的來來源資料集 ID。	d-rcdg3wxxxxxhc5jk87
SortBy	string	否	排序欄位枚舉值： DataSourceType : DataSourceType DataType : DataType GmtCreateTime : GmtCreateTime GmtModifiedTime : GmtModifiedTime	GmtCreateTime
ShareScope	string	否	分享資料集過濾器： TO_ME: 僅過濾分享給我的資料集。 BY_ME: 僅過濾我分享給他人的資料集，展示分享配置詳情。不設定該參數或設定為空白：擷取當前工作空間的所有的資料集，包括 TO_ME。枚舉值： TO_ME : TO_ME BY_ME : BY_ME	BY_ME
Edition	string	否	資料集類型。枚舉值： BASIC：基礎型。不支援資料集檔案中繼資料管理。 ADVANCED：進階型。僅 OSS 類型支援，每個版本支援最多 100 萬個檔案中繼資料管理。 LOGICAL: 邏輯型。僅 OSS 類型支援，每個版本支援最多 100 萬個檔案中繼資料管理。適用於絕大部分情境，需配合 SDK 使用。枚舉值： LOGICAL : LOGICAL BASIC : BASIC ADVANCED : ADVANCED	BASIC
Accessibility	string	否	資料集的可見度。 PUBLIC 表示公開。 PRIVATE 表示私人。枚舉值： PUBLIC : PUBLIC PRIVATE : PRIVATE	PRIVATE
DatasetIds	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回體。
RequestId	string	請求 ID。	5A14FA81-DD4E-******-6343FE44B941
Datasets	array	資料集列表。
	Dataset	資料集。
TotalCount	integer	總數。	15

樣本

正常返回樣本

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "Datasets": [
    {
      "DatasetId": "d-c0h44g3****j8o4348",
      "UserId": "2485765****023475",
      "OwnerId": "1631044****3440",
      "Name": "myName",
      "DataSourceType": "NAS",
      "Uri": "nas://09f****f2.cn-hangzhou/",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "DataType": "COMMON",
      "Property": "DIRECTORY",
      "SourceType": "USER",
      "SourceId": "jdnhf***fnrimv",
      "Description": "This is a description of a dataset.",
      "WorkspaceId": "478**",
      "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
      "Accessibility": "PRIVATE",
      "ProviderType": "Ecs",
      "SourceDatasetId": "d-bvfasdfxxxxj8o411",
      "SourceDatasetVersion": "v2",
      "TagTemplateType": "text-classification",
      "LatestVersion": {
        "VersionName": "v1",
        "GmtCreateTime": "2021-01-21T17:12:35.232Z",
        "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
        "Property": "FILE",
        "DataSourceType": "OSS",
        "Uri": "OSS://xxx",
        "Labels": [
          {
            "Key": "env",
            "Value": "test"
          }
        ],
        "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
        "SourceType": "USER",
        "Description": "base model v1",
        "SourceId": "d-65mrsr5fub4u74lej3",
        "DataCount": 10000,
        "DataSize": 10000,
        "MountAccess": "RO",
        "ImportInfo": "{\n    \"region\": \"cn-wulanchabu\",\n    \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n    \"path\": \"/mnt\",\n    \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n    \"isVpcMount\": true\n}"
      },
      "MountAccess": "RO RW",
      "ImportInfo": "{\n    \"region\": \"cn-wulanchabu\",\n    \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n    \"path\": \"/mnt\",\n    \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n    \"isVpcMount\": true\n}",
      "Edition": "BASIC",
      "IsShared": false,
      "SharedFrom": {
        "Status": "ACTIVE",
        "SourceTenantId": "148***************115",
        "SourceWorkspaceId": "33**19",
        "TenantId": "153***************249",
        "WorkspaceId": "42**2",
        "IsSecureMode": true,
        "SharedAt": "2025-08-27T12:23:58Z",
        "ExpiresAt": "2026-08-27T12:23:58Z",
        "AllowedMountAccessLevels": [
          "RO"
        ],
        "Extra": "{\"AllowExportModel\":false,\"AllowAccessDLCWebTerminal\":false,\"AllowAccessDLCFullLog\":false}"
      },
      "SharingConfig": {
        "SharedTo": [
          {
            "Status": "ACTIVE",
            "SourceTenantId": "148***************115",
            "SourceWorkspaceId": "33**19",
            "TenantId": "153***************249",
            "WorkspaceId": "42**2",
            "IsSecureMode": true,
            "SharedAt": "2025-08-27T12:23:58Z",
            "ExpiresAt": "2026-08-27T12:23:58Z",
            "AllowedMountAccessLevels": [
              "RO"
            ],
            "Extra": "{\"AllowExportModel\":false,\"AllowAccessDLCWebTerminal\":false,\"AllowAccessDLCFullLog\":false}"
          }
        ]
      },
      "Labels": [
        {
          "Key": "env",
          "Value": "test"
        }
      ],
      "MountAccessReadWriteRoleIdList": [
        "PAI.AlgoOperator"
      ],
      "AccessibleRoleIdList": [
        ""
      ]
    }
  ],
  "TotalCount": 15
}

錯誤碼

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

變更歷史

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