获取数据集详情-GetDatasetDetails
功能介绍
获取数据集详情
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataset:get
Read
workspace *
-
-
-
URI
GET /v1.0/{project_id}/common/datasets/{dataset_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 只能用小写字母 a-z 和数字 0-9组成,且长度为32个字符 默认取值: 不涉及 |
| dataset_id | 是 | String | 参数解释: 数据集id 约束限制: 不涉及 取值范围: 标准36位带横杠、小写UUID 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | GetLabelDatasetVoPayload object | 参数解释: 实际返回信息 |
| meta_info | MetaInfo 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 | 参数解释: 数据集下状态为成功的版本数量 取值范围: 不涉及 |
| source_dataset_name | String | 参数解释: 源数据集name 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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/61a22ebc-49b3-40b5-b16f-ab9aebd2b231 响应示例
状态码:200
查询成功
获取数据集详情
{
"meta_info" : {
"current_time" : "2024-01-02T02:04:22Z"
},
"payload" : {
"item" : {
"id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231",
"name" : "数据集1",
"description" : "测试数据集",
"data_type" : "IMAGE",
"latest_version" : 0,
"data_source" : "HOUSE",
"frame_num" : 0,
"frame_size" : 0,
"project_id" : "64d37c8f25af4277a1ff4ee9772687bf",
"workspace_id" : 0,
"label_format" : "OCTOPUS",
"label_count" : 0,
"label_taged" : false,
"create_at" : 1701403312027,
"update_at" : 1701403312027,
"data_source_info" : {
"data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8"
},
"version_count" : 0,
"has_finished" : true,
"version_success_count" : 0,
"dataset_form" : "DATASET"
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 参数校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。