文档首页/ 自动驾驶云服务 Octopus/ API参考/ API/ 数据批导/ 获取导入任务列表-ListCollectionRecords
更新时间:2026-04-30 GMT+08:00
分享

获取导入任务列表-ListCollectionRecords

功能介绍

获取导入任务列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:dataImportRecord:list

    List

    workspace *

    -

    -

    -

URI

GET /v1.0/{project_id}/data/import-records

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方法请参见获取项目ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

String

参数解释

工作空间ID

约束限制

不涉及

取值范围

不涉及

默认取值

0

offset

Integer

参数解释

查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空

约束限制

最小值0

取值范围

不涉及

默认取值

0

limit

Integer

参数解释

列表返回的最大记录数

约束限制

最小为1,最大为200

取值范围

不涉及

默认取值

10

status

String

参数解释

导入任务状态筛选,支持以逗号分隔填写多个值。最多20个。

约束限制

不涉及

取值范围

  • WAITING_IMPORT:数据待传输

  • IMPORTING:导入中

  • SUCCESS:成功

  • FAILED:失败

  • DELETING:删除中

  • DELETE_FAILED:删除失败

  • DELETED:已删除

默认取值

不涉及

id

String

参数解释

模糊查询:导入任务ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

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_DESC:更新时间降序

默认取值

UPDATE_AT_DESC

source_type

String

参数解释

传输方式

约束限制

不涉及

取值范围

  • OBS:对象存储

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

Content-Type

String

参数解释

内容类型。填application/json

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

payload

DataCollectListPayload object

参数解释

实际返回信息

meta_info

RespMetaInfo object

参数解释

元数据

表5 DataCollectListPayload

参数

参数类型

描述

list

Array of DataCollectionConsole objects

参数解释

返回的列表信息

page_info

PageInfo object

参数解释

分页信息

表6 DataCollectionConsole

参数

参数类型

描述

id

String

参数解释

导入ID

取值范围

不涉及

user_id

String

参数解释

用户ID

取值范围

不涉及

user_name

String

参数解释

用户名称

取值范围

不涉及

project_id

String

参数解释

项目ID

取值范围

不涉及

dcl_id

String

参数解释

导入任务ID

取值范围

不涉及

status

String

参数解释

导入任务状态

取值范围

  • WAITING_IMPORT:数据待传输

  • IMPORTING:导入中

  • SUCCESS:成功

  • FAILED:失败

  • DELETING:删除中

  • DELETE_FAILED:删除失败

  • DELETED:已删除

create_at

Long

参数解释

导入任务创建时间,UTC标准时间毫秒时间戳

取值范围

不涉及

update_at

Long

参数解释

导入任务更新时间,UTC标准时间毫秒时间戳

取值范围

不涉及

data_source

String

参数解释

导入数据路径

取值范围

不涉及

source_type

String

参数解释

传输方式

取值范围

  • OBS:对象存储

workspace_id

String

参数解释

工作空间ID

取值范围

不涉及

表7 PageInfo

参数

参数类型

描述

offset

Integer

参数解释

查询偏移量

取值范围

不涉及

limit

Integer

参数解释

返回个数上限

取值范围

不涉及

total

Integer

参数解释

资源总数

取值范围

不涉及

表8 RespMetaInfo

参数

参数类型

描述

current_time

String

参数解释

请求时间,UTC时间格式,时间为UTC标准时间

取值范围

不涉及

请求示例

查询数据导入任务列表

GET https://{endpoint}/v1.0/{project_id}/data/import-records?sort=CREATE_AT_DESC&offset=0&limit=10&status=SUCCESS

响应示例

状态码:200

查询成功

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "list" : [ {
      "id" : 111,
      "user_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "user_name" : "system",
      "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "dcl_id" : "DCL0000000000001",
      "status" : "SUCCESS",
      "create_at" : 1701312654552,
      "update_at" : 1701312802662,
      "data_source" : "octopus-user-087679f0aaxxxxxxxxxxxxxx2f5e902b/rosbag/DO202302010834046875241",
      "source_type" : "OBS"
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 10,
      "total" : 146
    }
  }
}

状态码

状态码

描述

200

查询成功

400

请求参数错误

403

权限校验失败

500

系统内部错误

错误码

请参见错误码

相关文档