文档

ListDatasets - 获取数据集列表

更新时间:

获取某个工作空间下的数据集列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/datasets

请求参数

名称类型必填描述示例值
PageNumberinteger

数据集列表的页码。起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页行数。默认为 10。

10
Orderstring

分页查询时,对指定的排序字段进行升序或降序。默认值为 ASC。

  • ASC:升序。
  • DESC:降序。
ASC
Namestring

数据集名称,支持根据数据集名称模糊搜索。

myName
Propertiesstring

数据集属性,多项之间使用半角逗号(,)分隔。支持以下取值:

  • DIRECTORY:文件夹。
  • FILE:文件。
FILE
DataSourceTypesstring

数据源类型,多项之间使用半角逗号分隔。支持以下取值:

  • NAS:数据存储为阿里云文件存储(NAS)。
  • OSS:数据存储为阿里云对象存储(OSS)。
OSS
DataTypesstring

数据集类型,多项之间使用半角逗号(,)分隔。支持以下取值:

  • VIDEO:视频。
  • COMMON:通用。
  • TEXT:文本。
  • PIC:图片。
  • AUDIO:音频。
COMMON,TEXT
SourceIdstring

数据来源 ID。

  • 当 SourceTypes 为 USER 时,SourceId 支持自定义。
  • 当 SourceTypes 为 ITAG 时,即 iTAG 模块标注结果生成的数据集时,SourceId 为 ITAG 的任务 ID。
  • 当 SourceTypes 为 PAI_PUBLIC_DATASET 时,即使用 PAI 公共数据集创建的数据集时,SourceId 默认为空。
d-rbvg5wzljzjhc9ks92
SourceTypesstring

来源类型,多项之间使用半角逗号分隔。支持以下取值:

  • PAI-PUBLIC-DATASET:PAI 公共数据集。
  • ITAG:iTAG 模块标注结果生成的数据集。
  • USER:用户注册的数据集。
枚举值:
  • PAI_PUBLIC_DATASETPAI_PUBLIC_DATASET
  • ITAGITAG
  • USERUSER
USER,ITAG
WorkspaceIdstring

数据集所在工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。 如果不配置该参数,则会使用默认工作空间;如果默认工作空间不存在,则会报错。

324**
Labelstring

数据集标签,用于过滤数据集列表。标签 Key 或 Value 中,有指定字符串的,都会被过滤出来。

test

返回参数

名称类型描述示例值
object

返回体。

RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941
Datasetsarray

数据集列表。

Dataset

数据集。

TotalCountlong

总数。

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"
    }
  ],
  "TotalCount": 15
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-27OpenAPI 入参发生变更查看变更详情