文档首页/ 自动驾驶云服务 Octopus/ API参考/ API/ 数据集/ 获取数据集列表
更新时间：2024-03-18 GMT+08:00
查看PDF
分享

获取数据集列表

功能介绍

获取数据集列表

URI

GET /v1.0/{project_id}/common/datasets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id，获取方法请参见获取项目ID
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

名称

最小长度：1

最大长度：64

data_type

否

String

枚举值：

  • IMAGE(图片)

  • POINT_CLOUD(点云)

  • TEXT(文本)

  • VIDEO(视频)

dataset_form

否

String

数据集类别

枚举值：

  • DATASET(数据集)

  • SUBSET(子集)

source_dataset_id

否

String

源数据集id

label_format

否

String

按标注格式筛选

枚举值：

  • OCTOPUS(OCTOPUS格式)

  • USER_DEFINE(自定义格式)

data_source

否

String

枚举值：

  • LABEL(标注任务)

  • LOCAL(本地)

  • OBS

  • HOUSE(数据仓库)

  • DATASET(数据集)

owner

否

String

数据集类型

枚举值：

  • CUSTOMER(自定义数据集)

  • SYSTEM(内置数据集)

order

否

String

查询结果的排序方式

缺省值：DESC

枚举值：

  • DESC(更新时间降序排列)

  • ASC(更新时间升序排列)

offset

否

Integer

查询偏移量

最小值：0

缺省值：0

limit

否

Integer

返回个数上限

最小值：1

最大值：100

缺省值：10

statuses

否

Array

枚举值：

  • CREATING(创建中)

  • IN_INTEGRATION(整合中)

  • EXPORTING(导出中)

  • SUCCESS(成功)

  • INTEGRATION_FAILED(整合失败)

  • EXPORT_FAILED(导出失败)

  • EXPORT_PRE_SUCCESS(导出中)

  • UPLOAD_SUSPENDED(上传中断)

  • INITIALIZING(初始化)

label_taged

否

Boolean

标注数据集tag，已标注是true，未标注是false

select_source_dataset

否

Boolean

是否查询源数据集list，是true，否false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

payload

LabelDatasetVOPayload object

实际返回信息

meta_info

MetaInfo object

元数据
表5 LabelDatasetVOPayload

参数

参数类型

描述

list

Array of LabelDatasetVO objects

数据集列表

page_info

PageInfo object

分页信息
表6 LabelDatasetVO

参数

参数类型

描述

id

String

id

name

String

名称

description

String

描述

data_type

String

数据类型

枚举值：

  • IMAGE(图片)

  • POINT_CLOUD(点云)

  • TEXT(文本)

  • VIDEO(视频)

dataset_form

String

数据集形式

枚举值：

  • DATASET(数据集)

  • SUBSET(子集)

source_dataset_id

String

子集的源数据集ID

latest_version

Integer

最新版本

data_source

String

数据来源

枚举值：

  • LABEL(标注)

  • LOCAL(本地)

  • OBS

  • HOUSE(数据仓库)

  • DATASET(数据集)

owner

String

数据集类型

枚举值：

  • CUSTOMER(自定义数据集)

  • SYSTEM(内置数据集)

frame_num

Long

文件数

frame_size

Long

数据集下版本帧文件总大小，单位字节

project_id

String

项目id

label_format

String

标注格式

枚举值：

  • OCTOPUS(OCTOPUS格式)

  • USER_DEFINE(自定义格式)

label_count

Long

标注物数量

label_names

Array of strings

所有标注物名称

create_at

Long

创建时间，UTC标准时间毫秒时间戳

update_at

Long

修改时间，UTC标准时间毫秒时间戳

label_taged

Boolean

标注数据集tag，已标注是true

label_associated

Boolean

标注服务中，标注任务是否关联该数据集，关联了为true

data_source_info

DataSourceInfoList object

数据相关信息

tags

Array of strings

标签

最大长度：64

custom_attributes

Array of strings

自定义属性，格式形如"key:value"

version_count

Integer

版本数量

has_finished

Boolean

是否结束，该数据集下没有非终止状态下的版本表示结束，成功或失败表示终止状态

version_success_count

Integer

数据集下状态为成功的版本数量

publish_status

String

发布状态

枚举值：

  • SUCCESS(成功)

  • DOING(导入中)

  • FAIL(失败)

  • UN_PUBLISH(未发布)

file_size

String

数据集所有版本文件总大小，包含具体单位
表7 DataSourceInfoList

参数

参数类型

描述

label_project_package_id

String

任务项目包ID

label_project_package_name

String

任务项目包名称

batch_task_ids

Array of strings

批次任务ID

data_warehouse_id

String

数据仓库ID

raw_data_ids

Array of strings

原始数据包ID

data_process_task_ids

Array of strings

处理任务ID
表8 PageInfo

参数

参数类型

描述

total

Long

资源总数

offset

Long

查询偏移量

limit

Long

返回个数上限
表9 MetaInfo

参数

参数类型

描述

current_time

String

请求时间，UTC时间格式，时间为UTC标准时间

请求示例

获取数据集列表

GET https://{endpoint}/v1.0/{project_id}/common/datasets?offset=0&limit=10

响应示例

状态码： 200

查询成功

  • 获取数据集列表

    {
  "payload" : {
    "list" : [ {
      "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231",
      "name" : "dataset_name",
      "description" : "",
      "data_type" : "IMAGE",
      "latest_version" : 3,
      "data_source" : "HOUSE",
      "frame_num" : 123,
      "frame_size" : 93398989,
      "project_id" : "64d37c8f25af4277a1ff4ee9772687bf",
      "label_format" : "OCTOPUS",
      "label_count" : 0,
      "label_taged" : "false,",
      "label_associated" : "false,",
      "create_at" : 1701077827974,
      "update_at" : 1701335688724,
      "data_source_info" : {
        "data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8",
        "data_process_task_ids" : [ "frame-extract-2077" ]
      },
      "tags" : [ "接管", "大客车", "停车位", "小区内部路", "乡村道路", "卡车", "一般道路", "轿车" ],
      "custom_attributes" : [ "city:tencent", "city:sunny", "city:not-a-plate" ],
      "version_count" : 3,
      "has_finished" : true,
      "version_success_count" : 0,
      "publish_status" : "UN_PUBLISH",
      "file_size" : "89.07MB"
    } ],
    "page_info" : {
      "total" : 237,
      "offset" : 0,
      "limit" : 10
    }
  },
  "meta_info" : {
    "current_time" : "2024-01-02T02:04:22Z"
  }
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码。

父主题： 数据集

相关文档