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

获取数据包列表

功能介绍

获取数据包列表

URI

GET /v1.0/{project_id}/data/packages

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

offset

否

Integer

查询偏移量

最小值：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(删除失败)

  • DELETED(已删除)

id

否

String

模糊查询：数据包ID

最大长度：255

ids

否

Array

批量查询：数据包ID

最大长度：200

name

否

String

模糊查询：数据包名称

最大长度：255

vehicle_name

否

String

车辆名称

最大长度：255

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

排序方式

缺省值：UPDATE_AT_DESC(更新时间降序)

枚举值：

  • CREATE_AT_ASC(导入时间升序)

  • CREATE_AT_DESC(导入时间降序)

  • UPDATE_AT_ASC(更新时间升序)

  • UPDATE_AT_DESC(更新时间降序)

  • STORAGE_SIZE_ASC(数据量升序)

  • STORAGE_SIZE_DESC(数据量降序)

is_recycle

是

Boolean

是否已回收

data_source

否

String

传输方式

枚举值：

  • OBS(对象存储)

  • DES(数据递送)

project

否

String

项目

最大长度：255

module

否

String

模块

最大长度：255

tags

否

Array

标签筛选，最大长度10

station

否

String

采集站点

最大长度：255

mode

否

String

驾驶模式

最大长度：255

collect_start_at

否

Long

最小收集时间，UTC标准时间毫秒时间戳

最小值：1000000000000

最大值：2000000000000

collect_end_at

否

Long

最大收集时间，UTC标准时间毫秒时间戳

最小值：1000000000000

最大值：2000000000000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

payload

DataPackageListPayload object

实际返回信息

meta_info

RespMetaInfo object

元数据
表5 DataPackageListPayload

参数

参数类型

描述

list

Array of DataPackageListVo objects

数据包列表信息

page_info

PageInfo object

分页信息
表6 DataPackageListVo

参数

参数类型

描述

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(删除失败)

  • DELETED(已删除)

name

String

数据包名称

data_type

String

数据包类型

枚举值：

  • ROSBAG

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

是否能够回放

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
表7 PageInfo

参数

参数类型

描述

offset

Integer

查询偏移量

limit

Integer

返回个数上限

total

Integer

资源总数
表8 RespMetaInfo

参数

参数类型

描述

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" : "087679f0aa80d32a2f4ec0172f5e902b",
      "project_id" : "087679f0aa80d32a2f4ec0172f5e902b",
      "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

系统内部错误

错误码

请参见错误码。

父主题： 数据包

相关文档