获取数据集列表-GetDatasetList
功能介绍
获取数据集列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataset:list
List
workspace *
-
-
-
URI
GET /v1.0/{project_id}/common/datasets
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 只能用小写字母 a-z 和数字 0-9组成,且长度为32个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 名称 约束限制: 不涉及 取值范围: 只能用中文字符、大小写英文字母、数字、“_”、“-”组成,且长度为[1~64]个字符 默认取值: 不涉及 |
| data_type | 否 | String | 参数解释: 数据类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| dataset_form | 否 | String | 参数解释: 数据集类别 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| source_dataset_id | 否 | String | 参数解释: 源数据集id 约束限制: 不涉及 取值范围: 标准36位带横杠、小写UUID 默认取值: 不涉及 |
| label_format | 否 | String | 参数解释: 按标注格式筛选 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| data_source | 否 | String | 参数解释: 数据来源 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| owner | 否 | String | 参数解释: 数据集类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| order | 否 | String | 参数解释: 查询结果的排序方式 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 查询偏移量 约束限制: 与limit配合使用 取值范围: 最小值为0 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 返回个数上限 约束限制: 与offset配合使用 取值范围: 最小值为1,最大值为100 默认取值: 10 |
| statuses | 否 | Array of strings | 参数解释: 状态 约束限制: 不涉及 |
| label_taged | 否 | Boolean | 参数解释: 标注数据集tag 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| select_source_dataset | 否 | Boolean | 参数解释: 是否查询源数据集 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| workspace_id | 否 | String | 参数解释: 工作空间id 约束限制: 不涉及 取值范围: 小写带横杠UUID或小写无横杠UUID或单个0 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | LabelDatasetVOPayload object | 参数解释: 实际返回信息 |
| meta_info | MetaInfo object | 参数解释: 元数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| list | Array of LabelDatasetVO objects | 参数解释: 数据集列表 |
| page_info | PageInfo object | 参数解释: 分页信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 数据集id 取值范围: 不涉及 |
| name | String | 参数解释: 名称 取值范围: 不涉及 |
| description | String | 参数解释: 描述 取值范围: 不涉及 |
| data_type | String | 参数解释: 数据类型 取值范围: |
| dataset_form | String | 参数解释: 数据集形式 取值范围: |
| source_dataset_id | String | 参数解释: 子集的源数据集ID 取值范围: 不涉及 |
| latest_version | Integer | 参数解释: 最新版本 取值范围: 不涉及 |
| data_source | String | 参数解释: 数据来源 取值范围: |
| owner | String | 参数解释: 数据集类型 取值范围: |
| frame_num | Long | 参数解释: 文件数 取值范围: 不涉及 |
| frame_size | Long | 参数解释: 数据集下版本帧文件总大小,单位字节 取值范围: 不涉及 |
| project_id | String | 参数解释: 项目id 取值范围: 不涉及 |
| workspace_id | String | 参数解释: 工作空间id 取值范围: 不涉及 |
| label_format | String | 参数解释: 标注格式 取值范围: |
| label_count | Long | 参数解释: 标注物数量 取值范围: 不涉及 |
| label_names | Array of strings | 参数解释: 所有标注物名称 |
| create_at | Long | 参数解释: 创建时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| update_at | Long | 参数解释: 修改时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| label_taged | Boolean | 参数解释: 标注数据集tag,已标注是true 取值范围: 不涉及 |
| data_source_info | DataSourceInfoList object | 参数解释: 数据相关信息 |
| tags | Array of strings | 参数解释: 标签 |
| custom_attributes | Array of strings | 参数解释: 自定义属性,格式形如"key:value" |
| version_count | Integer | 参数解释: 版本数量 取值范围: 不涉及 |
| has_finished | Boolean | 参数解释: 是否结束,该数据集下没有非终止状态下的版本表示结束,成功或失败表示终止状态 取值范围: 不涉及 |
| version_success_count | Integer | 参数解释: 数据集下状态为成功的版本数量 取值范围: 不涉及 |
| publish_status | String | 参数解释: 发布状态 取值范围: |
| file_size | String | 参数解释: 数据集所有版本文件总大小,包含具体单位 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 |
请求示例
获取数据集列表
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,",
"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 | 系统内部错误 |
错误码
请参见错误码。