调用ListDatasets获取数据集列表_人工智能平台 PAI(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
Name	string	否	数据集名称，支持根据数据集名称模糊搜索。	myName
Properties	string	否	数据集属性，多项之间使用半角逗号（,）分隔。支持以下取值： DIRECTORY：文件夹。 FILE：文件。	FILE
DataSourceTypes	string	否	数据源类型，多项之间使用半角逗号分隔。支持以下取值： NAS：数据存储为阿里云文件存储（NAS）。 OSS：数据存储为阿里云对象存储（OSS）。	OSS
DataTypes	string	否	数据集类型，多项之间使用半角逗号（,）分隔。支持以下取值： VIDEO：视频。 COMMON：通用。 TEXT：文本。 PIC：图片。 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 公共数据集。 ITAG：iTAG 模块标注结果生成的数据集。 USER：用户注册的数据集。枚举值： 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

返回参数

名称	类型	描述	示例值
	object	返回体。
RequestId	string	请求 ID。	5A14FA81-DD4E-******-6343FE44B941
Datasets	array	数据集列表。
Datasets	Dataset	数据集。
TotalCount	long	总数。	15

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "Datasets": [
    {
      "DatasetId": "d-c0h44g3****j8o4348",
      "UserId": "2485765****023475",
      "OwnerId": "1631044****3440",
      "Name": "myName",
      "Labels": [
        {
          "Key": "env",
          "Value": "test"
        }
      ],
      "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": "用于标注的数据。",
      "WorkspaceId": "478**",
      "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
      "Accessibility": "PRIVATE",
      "ProviderType": "Ecs",
      "SourceDatasetId": "d-bvfasdfxxxxj8o411",
      "SourceDatasetVersion": "v2",
      "TagTemplateType": "text-classification",
      "LatestVersion": {
        "VersionName": "v1",
        "GmtCreateTime": "",
        "GmtModifiedTime": "",
        "Property": "FILE",
        "DataSourceType": "OSS",
        "Uri": "OSS://xxx",
        "Labels": [
          {
            "Key": "env",
            "Value": "test"
          }
        ],
        "Options": "",
        "SourceType": "",
        "Description": "",
        "SourceId": "",
        "DataCount": 0,
        "DataSize": 0
      }
    }
  ],
  "TotalCount": 15
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-18	OpenAPI 入参发生变更	查看变更详情
2024-07-09	API 内部配置变更，不影响调用	查看变更详情
2024-02-27	OpenAPI 入参发生变更	查看变更详情