调用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 : ASC DESC : DESC	ASC
Name	string	否	数据集名称，支持根据数据集名称模糊搜索。	myName
Properties	string	否	数据集属性，多项之间使用半角逗号（,）分隔。支持以下取值： DIRECTORY：文件夹。 FILE：文件。枚举值： DIRECTORY : DIRECTORY FILE : FILE	FILE
DataSourceTypes	string	否	数据源类型，多项之间使用半角逗号分隔。支持以下取值： NAS：数据存储为阿里云文件存储（NAS）。 OSS：数据存储为阿里云对象存储（OSS）。枚举值： 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

返回参数

名称	类型	描述	示例值
	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",
      "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": "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",
      "MountAccessReadWriteRoleIdList": [
        "PAI.AlgoOperator"
      ],
      "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"
    }
  ],
  "TotalCount": 15
}

错误码

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

变更历史

更多信息，参考变更详情。