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

获取导入任务详情-GetCollectionById

功能介绍

获取导入任务详情

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:dataImportRecord:get

    Read

    workspace *

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

id

是

String

参数解释:

收集任务ID

约束限制:

以DCL开头加13位数字

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

是

String

参数解释:

内容类型。填application/json

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

payload

DataCollectionInfoPayload object

参数解释:

实际返回信息

meta_info

RespMetaInfo object

参数解释:

元数据

表4 DataCollectionInfoPayload

参数

参数类型

描述

item

DataCollectionDetail object

参数解释:

收集任务详情明细

表5 DataCollectionDetail

参数

参数类型

描述

id

String

参数解释:

导入任务ID

取值范围:

不涉及

user_id

String

参数解释:

用户ID

取值范围:

不涉及

user_name

String

参数解释:

用户名

取值范围:

不涉及

project_id

String

参数解释:

项目ID

取值范围:

不涉及

dcl_id

String

参数解释:

导入任务ID

取值范围:

不涉及

create_at

Long

参数解释:

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

取值范围:

不涉及

update_at

Long

参数解释:

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

取值范围:

不涉及

data_source

String

参数解释:

导入数据数据源

取值范围:

不涉及

source_type

String

参数解释:

导入任务数据类型

取值范围:

不涉及

import_progress

DataCollectionImportProgress object

参数解释:

导入任务进度

import_config

DataCollectionImportConfig object

参数解释:

导入任务配置

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

表6 DataCollectionImportProgress

参数

参数类型

描述

status

String

参数解释:

导入任务状态

取值范围:

  • WAITING_IMPORT:数据待传输

  • IMPORTING:导入中

  • SUCCESS:成功

  • FAILED:失败

  • DELETING:删除中

  • DELETE_FAILED:删除失败

total_num

Long

参数解释:

导入数据包总数量

取值范围:

不涉及

success_num

Long

参数解释:

导入数据包成功数

取值范围:

不涉及

failed_num

Long

参数解释:

导入数据包失败数

取值范围:

不涉及

importing_num

Long

参数解释:

正在导入数据包数量

取值范围:

不涉及

表7 DataCollectionImportConfig

参数

参数类型

描述

type

String

参数解释:

导入任务数据类型

取值范围:

不涉及

path

String

参数解释:

数据包路径

取值范围:

不涉及

packages

Array of strings

参数解释:

数据包名列表

agreement_confirm

Boolean

参数解释:

是否同意协议

取值范围:

不涉及

is_select_all_packages

Boolean

参数解释:

是否选择所有数据包

取值范围:

不涉及

priority

Integer

参数解释:

数据包处理任务优先级

取值范围:

不涉及

opendata_processor_config

DataProcessorConfig object

参数解释:

转opendata处理任务

desensitize_processor_config

DataProcessorConfig object

参数解释:

脱敏处理任务

表8 DataProcessorConfig

参数

参数类型

描述

processor_id

Long

参数解释:

算子ID,配置算子时此项必填

约束限制:

最小值1

取值范围:

不涉及

默认取值:

不涉及

resource_spec

String

参数解释:

资源规格,配置算子时此项必填,示例:1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

envs

Array of JobEnv objects

参数解释:

环境变量

约束限制:

最多十组

cluster_type

String

参数解释:

集群类型

约束限制:

不涉及

取值范围:

  • CCE

  • MODELARTS

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表9 JobEnv

参数

参数类型

描述

key

String

参数解释:

环境变量键

约束限制:

不能重复,配置环境变量时此项必填

取值范围:

不涉及

默认取值:

不涉及

value

String

参数解释:

环境变量值

约束限制:

配置环境变量时此项必填

取值范围:

不涉及

默认取值:

不涉及

表10 RespMetaInfo

参数

参数类型

描述

current_time

String

参数解释:

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

取值范围:

不涉及

请求示例

获取导入任务详情

PUT https://{endpoint}/v1.0/{project_id}/data/import-records/DCL0000000000001

响应示例

状态码:200

查询成功

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "item" : {
      "id" : 485,
      "user_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "user_name" : "system",
      "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "dcl_id" : "DCL0000000000001",
      "create_at" : 1701312654552,
      "update_at" : 1701312802662,
      "data_source" : "octopus-user-087679f0aaxxxxxxxxxxxxxx2f5e902b/rosbag/DO202302010834046875241",
      "source_type" : "OBS",
      "import_progress" : {
        "status" : "SUCCESS",
        "total_num" : 1,
        "success_num" : 1,
        "failed_num" : 0,
        "importing_num" : 0
      },
      "import_config" : {
        "type" : "OBS",
        "path" : "octopus-user-087679f0aaxxxxxxxxxxxxxx2f5e902b/rosbag/DO202302010834046875241",
        "packages" : [ "package1" ],
        "agreement_confirm" : true,
        "is_select_all_packages" : false,
        "opendata_processor_config" : {
          "processor_id" : 10276,
          "resource_spec" : "4Core_8GiB"
        },
        "priority" : 0
      }
    }
  }
}

状态码

状态码

描述

200

查询成功

400

请求参数错误

403

权限校验失败

404

找不到请求的资源

500

系统内部错误

错误码

请参见错误码。

相关文档