# 获取数据包列表-GetDataPackageList #### 功能介绍 获取数据包列表 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:dataPackage:list | List | workspace \* | - | - | - | #### URI GET /v1.0/{project_id}/data/packages 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 0 | | offset | 否 | Integer | **参数解释**： 查询偏移量，与limit配合使用。假如设置offset为11，limit为10，即从第12条数据开始查询，一次最多读取10条记录。当offset超过总记录数时，列表返回为空 **约束限制**： 最小值0 **取值范围**： 不涉及 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 列表返回的最大记录数 **约束限制**： 最小为1，最大为200 **取值范围**： 不涉及 **默认取值**： 10 | | status | 否 | String | **参数解释**： 数据包状态 **约束限制**： 配合is_recycle字段使用。 is_recycle=true时，状态有NOT_RECYCLED，RECYCLED，DELETING，FAILED，DELETED。 is_recycle=false时，状态有CREATED，SCANNING，NORMAL，ABNORMAL，PRE_DESENSITIZATION，IN_DESENSITIZATION，DESENSITIZATION_SUCCESS，DESENSITIZATION_FAILED **取值范围**： - CREATED：已创建 - SCANNING：扫描中 - NORMAL：导入完成 - ABNORMAL：导入异常 - PRE_DESENSITIZATION：待脱敏 - IN_DESENSITIZATION：脱敏中 - DESENSITIZATION_SUCCESS：脱敏完成 - DESENSITIZATION_FAILED：脱敏失败 - NOT_RECYCLED：未回收 - RECYCLED：待处理 - DELETING：删除中 - FAILED：删除失败 **默认取值**： 不涉及 | | id | 否 | String | **参数解释**： 模糊查询：数据包ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | ids | 否 | Array of strings | **参数解释**： 批量精确查询：数据包ID。多个数据包ID以逗号分隔 **约束限制**： 一次最多查询200条 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | 否 | String | **参数解释**： 模糊查询：数据包名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | vehicle_name | 否 | String | **参数解释**： 车辆名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | dcl_id | 否 | String | **参数解释**： 导入任务ID **约束限制**： DCL或DO开头，加13位数字 **取值范围**： 不涉及 **默认取值**： 不涉及 | | calibration_id | 否 | Long | **参数解释**： 标定ID **约束限制**： 最小为1 **取值范围**： 不涉及 **默认取值**： 不涉及 | | start_at | 否 | Long | **参数解释**： 最小导入时间，UTC标准时间毫秒时间戳 **约束限制**： 不涉及 **取值范围**： 1000000000000-2000000000000 **默认取值**： 不涉及 | | end_at | 否 | Long | **参数解释**： 最大导入时间，UTC标准时间毫秒时间戳 **约束限制**： 不涉及 **取值范围**： 1000000000000-2000000000000 **默认取值**： 不涉及 | | sort | 否 | String | **参数解释**： 排序方式 **约束限制**： 不涉及 **取值范围**： - CREATE_AT_ASC：导入时间升序 - CREATE_AT_DESC：导入时间降序 - UPDATE_AT_ASC：更新时间升序 - UPDATE_AT_DES：更新时间降序 - STORAGE_SIZE_ASC：数据量升序 - STORAGE_SIZE_DESC：数据量降序 **默认取值**： UPDATE_AT_DESC | | is_recycle | 是 | Boolean | **参数解释**： 数据包是否已回收，当数据包删除时会先放入回收站，此时状态为已回收 **约束限制**： 不涉及 **取值范围**： - true：已回收 - false：未回收 **默认取值**： 不涉及 | | data_source | 否 | String | **参数解释**： 传输方式 **约束限制**： 不涉及 **取值范围**： - OBS：对象存储 - DES：数据递送 **默认取值**： 不涉及 | | project | 否 | String | **参数解释**： 项目 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | module | 否 | String | **参数解释**： 模块 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | tags | 否 | Array of integers | **参数解释**： 标签ID筛选，以逗号分割 **约束限制**： 最多筛选10个标签 **取值范围**： 不涉及 **默认取值**： 不涉及 | | station | 否 | String | **参数解释**： 采集站点 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | mode | 否 | String | **参数解释**： 驾驶模式 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | collect_start_at | 否 | Long | **参数解释**： 最小收集时间，UTC标准时间毫秒时间戳 **约束限制**： 不涉及 **取值范围**： 1000000000000-2000000000000 **默认取值**： 不涉及 | | collect_end_at | 否 | Long | **参数解释**： 最大收集时间，UTC标准时间毫秒时间戳 **约束限制**： 不涉及 **取值范围**： 1000000000000-2000000000000 **默认取值**： 不涉及 | | has_opendata | 否 | Boolean | **参数解释**： 是否是opendata数据包 **约束限制**： 不涉及 **取值范围**： - true：是 - false：否 **默认取值**： false | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | Content-Type | 是 | String | **参数解释**： 内容类型。填application/json **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | payload | [DataPackageListPayload] object | **参数解释**： 实际返回信息 | | meta_info | [RespMetaInfo] object | **参数解释**： 元数据 | 表5DataPackageListPayload | 参数 | 参数类型 | 描述 | |:---|:---|:---| | list | Array of [DataPackageListVo] objects | **参数解释**： 数据包列表信息 | | page_info | [PageInfo] object | **参数解释**： 分页信息 | 表6DataPackageListVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 数据包ID **取值范围**： 不涉及 | | user_id | String | **参数解释**： 用户ID **取值范围**： 不涉及 | | project_id | String | **参数解释**： 项目ID **取值范围**： 不涉及 | | dcl_id | String | **参数解释**： 导入任务ID **取值范围**： 不涉及 | | status | String | **参数解释**： 数据包状态 **取值范围**： - CREATED：已创建 - SCANNING：扫描中 - NORMAL：导入完成 - ABNORMAL：导入异常 - PRE_DESENSITIZATION：待脱敏 - IN_DESENSITIZATION：脱敏中 - DESENSITIZATION_SUCCESS：脱敏完成 - DESENSITIZATION_FAILED：脱敏失败 - NOT_RECYCLED：未回收 - RECYCLED：待处理 - DELETING：删除中 - FAILED：删除失败 | | name | String | **参数解释**： 数据包名称 **取值范围**： 不涉及 | | data_type | String | **参数解释**： 数据包类型 **取值范围**： 不涉及 | | vehicle_id | Long | **参数解释**： 车辆ID **取值范围**： 不涉及 | | vehicle_name | String | **参数解释**： 车辆名称 **取值范围**： 不涉及 | | calibration_id | Long | **参数解释**： 标定id(数据包yaml没有写此项 ，则不返回此项) **取值范围**： 不涉及 | | storage_size | Long | **参数解释**： 数据包大小 **取值范围**： 不涉及 | | recycled_time | Long | **参数解释**： 放入回收站时间，UTC标准时间毫秒时间戳(数据包没有放入回收站 ，则不返回此项) **取值范围**： 不涉及 | | create_at | Long | **参数解释**： 数据包创建时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | update_at | Long | **参数解释**： 数据包更新时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | can_replay | Boolean | **参数解释**： 是否能够回放 **取值范围**： - true：可以回放 - false：不能回放 | | data_source | String | **参数解释**： 传输方式 **取值范围**： - OBS：对象存储 - DES：数据递送 | | topic_types | Array of strings | **参数解释**： 传感器类型 **取值范围**： 不涉及 | | replay_job_status | Integer | **参数解释**： 回放作业状态 **取值范围**： - 1：未解析 - 2：已完成 - 3：解析失败 - 4：未回放处理 - 5：回放处理失败 | | processor_job_ids | Array of longs | **参数解释**： 数据包处理作业id | | processor_ids | Array of longs | **参数解释**： 数据包处理算子ID | | workspace_id | String | **参数解释**： 工作空间ID **取值范围**： 不涉及 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | **参数解释**： 查询偏移量 **取值范围**： 不涉及 | | limit | Integer | **参数解释**： 返回个数上限 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 资源总数 **取值范围**： 不涉及 | 表8RespMetaInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 | #### 请求示例 获取数据包列表 ``` GET https://{endpoint}/v1.0/{project_id}/data/packages?status=NORMAL&sort=CREATE_AT_DESC&offset=0&limit=10&is_recycle=false ``` #### 响应示例 **状态码：200** 查询成功 ``` { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "id" : "DPK0000001", "user_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "dcl_id" : "DCL0000000000001", "status" : "NORMAL", "name" : "package_name", "data_type" : "ROSBAG", "vehicle_id" : 228, "vehicle_name" : "test", "storage_size" : 2882433681, "create_at" : 1701312661439, "update_at" : 1701313102802, "can_replay" : true, "topic_types" : [ "CAMERA", "LIDAR", "GNSS", "EGO_TF" ], "data_source" : "OBS", "replay_job_status" : 2, "processor_job_ids" : [ 4275 ], "processor_ids" : [ 10276 ] } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 8 } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 请求参数错误 | | 403 | 权限校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。