# 获取数据集版本列表-GetDatasetVersionList #### 功能介绍 获取数据集版本列表 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:dataset:list | List | workspace \* | - | - | - | #### URI GET /v1.0/{project_id}/common/datasets/{dataset_id}/versions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 只能用小写字母 a-z 和数字 0-9组成，且长度为32个字符 **默认取值**： 不涉及 | | dataset_id | 是 | String | **参数解释**： 数据集id **约束限制**： 不涉及 **取值范围**： 标准36位带横杠、小写UUID **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 根据名称模糊查询 **约束限制**： 不涉及 **取值范围**： 长度为\[1\~64\] **默认取值**： 不涉及 | | statuses | 否 | Array of strings | **参数解释**： 根据数据集版本状态筛选 **约束限制**： 不涉及 | | order | 否 | String | **参数解释**： 查询结果的排序方式 **约束限制**： 不涉及 **取值范围**： - DESC：更新时间降序 - ASC：更新时间升序 **默认取值**： 不涉及 | | offset | 否 | Integer | **参数解释**： 查询偏移量 **约束限制**： 与limit配合使用 **取值范围**： 最小值为0 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 返回个数上限 **约束限制**： 与offset配合使用 **取值范围**： 最小值为1，最大值为100 **默认取值**： 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 内容类型。填application/json **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | payload | [LabelDatasetVersionListPayload] object | **参数解释**： 实际返回信息 | | meta_info | [MetaInfo] object | **参数解释**： 元数据 | 表5LabelDatasetVersionListPayload | 参数 | 参数类型 | 描述 | |:---|:---|:---| | page_info | [PageInfo] object | **参数解释**： 分页信息 | | list | Array of [LabelDatasetVersionListVO] objects | **参数解释**： 版本列表 | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释**： 资源总数 **取值范围**： 不涉及 | | offset | Long | **参数解释**： 查询偏移量 **取值范围**： 不涉及 | | limit | Long | **参数解释**： 返回个数上限 **取值范围**： 不涉及 | 表7LabelDatasetVersionListVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 数据集版本id **取值范围**： 不涉及 | | label_dataset_id | String | **参数解释**： 数据集id **取值范围**： 不涉及 | | tags | Array of strings | **参数解释**： 标签 | | custom_attributes | Array of strings | **参数解释**： 自定义属性，格式形式"key:value" | | label_names | Array of strings | **参数解释**： 标注物名 | | name | String | **参数解释**： 名称 **取值范围**： 不涉及 | | batch_task_id | String | **参数解释**： 批次任务id **取值范围**： 不涉及 | | label_meta_names | Array of strings | **参数解释**： 标注物名 | | label_format | String | **参数解释**： 标注格式 **取值范围**： - OCTOPUS：OCTOPUS格式 - USER_DEFINE：自定义格式 | | status | String | **参数解释**： 状态 **取值范围**： - CREATING：创建中 - IN_INTEGRATION：整合中 - IMPORTING：导入中 - SUCCESS：完成 - INTEGRATION_FAILED：整合失败 - IMPORT_FAILED：导入失败 - IMPORT_PRE_SUCCESS：导入任务,标注数据准备成功 - UPLOAD_SUSPENDED：上传中断 - INITIALIZING：初始化 | | frame_num | String | **参数解释**： 帧文件数量 **取值范围**： 不涉及 | | frame_size | String | **参数解释**： 帧文件大小，包含单位 **取值范围**： 不涉及 | | label_count | String | **参数解释**： 标志物数量 **取值范围**： 不涉及 | | custom_image | String | **参数解释**： 自定义镜像 **取值范围**： 不涉及 | | command | String | **参数解释**： 脚本路径 **取值范围**： 不涉及 | | cluster_id | String | **参数解释**： 集群id **取值范围**： 不涉及 | | spec | String | **参数解释**： 资源规格 **取值范围**： 不涉及 | | description | String | **参数解释**： 描述 **取值范围**： 不涉及 | | project_id | String | **参数解释**： 项目id **取值范围**： 不涉及 | | workspace_id | String | **参数解释**： 工作空间id **取值范围**： 不涉及 | | create_at | String | **参数解释**： 创建时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | update_at | String | **参数解释**： 修改时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | upload_id | String | **参数解释**： 上传id **取值范围**： 不涉及 | | agreement_confirm | Boolean | **参数解释**： 隐私声明同意 **取值范围**： 不涉及 | | source_version_id | String | **参数解释**： 子集的源数据集版本ID **取值范围**： 不涉及 | | has_finished | Boolean | **参数解释**： 已经结束，该数据集下没有非终止状态下的版本表示结束，成功或失败表示终止状态 **取值范围**： 不涉及 | | file_size | String | **参数解释**： 文件大小，带单位 **取值范围**： 不涉及 | 表8MetaInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 | #### 请求示例 获取数据集版本列表 ``` GET https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions?offset=0&limit=10 ``` #### 响应示例 **状态码：200** 查询成功 获取数据集版本列表 ``` { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "list" : [ { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "SUCCESS", "frame_num" : 100, "frame_size" : 47518529, "label_count" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701393989718, "update_at" : 1701394037579, "has_finished" : true, "file_size" : "45.32MB", "custom_image" : "10293:1", "command" : "command", "cluster_id" : "e899e611-5571-41ee-ab0c-cc6c94293d93", "spec" : "Ant03_1Gpu_6Core_12GiB", "description" : "描述" } ], "page_info" : { "total" : 1, "offset" : 0, "limit" : 10 } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 参数校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。