更新时间:2024-02-06 GMT+08:00
分享

获取导入任务列表

功能介绍

获取导入任务列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询偏移量

最小值:0

缺省值:0

limit

Integer

返回个数上限

最小值:1

最大值:200

缺省值:10

status

String

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

枚举值:

  • WAITING_IMPORT(数据待传输)

  • IMPORTING(导入中)

  • SUCCESS(成功)

  • FAILED(失败)

  • DELETING(删除中)

  • DELETE_FAILED(删除失败)

  • DELETED(已删除)

id

String

模糊查询:导入任务ID

最大长度:255

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(更新时间降序)

source_type

String

传输方式

枚举值:

  • OBS(对象存储)

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 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)对象存储

表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" : "087679f0aa80d32a2f4ec0172f5e902b",
      "user_name" : "system",
      "project_id" : "087679f0aa80d32a2f4ec0172f5e902b",
      "dcl_id" : "DCL0000000000001",
      "status" : "SUCCESS",
      "create_at" : 1701312654552,
      "update_at" : 1701312802662,
      "data_source" : "octopus-user-087679f0aa80d32a2f4ec0172f5e902b/rosbag/DO202302010834046875241",
      "source_type" : "OBS"
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 10,
      "total" : 146
    }
  }
}

状态码

状态码

描述

200

查询成功

400

请求参数错误

403

权限校验失败

500

系统内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品