文档首页/ 云空间服务 KooDrive/ API参考/ API/ 批量任务操作/ 查询批量操作任务详情
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

查询批量操作任务详情

功能介绍

查询某个批量操作任务的详情。

URI

GET /koodrive/ose/v1/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

批量任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}

X-User-Id

是

String

用户id,用于app鉴权

X-Date

是

String

日期,用于app鉴权

Host

是

String

地址,用于app鉴权

X-Traceid

否

String

消息日志跟踪标识(必须58位)

language

否

String

国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应消息

data

data object

任务详情
表4 data

参数

参数类型

描述

jobInfo

JobDetailInfo object

任务信息

taskInfos

Array of TaskInfo objects

Task详情列表

uncompressedFileList

Array of UncompressedFileInfo objects

压缩包内文件信息
表5 JobDetailInfo

参数

参数类型

描述

taskId

String

任务标识

taskName

String

任务名称

userId

String

任务创建者的用户ID

taskType

Integer

任务类型

actionType

Integer

操作类型

status

Integer

任务状态

  • 0:待处理

  • 1:处理中

  • 2:已完成

  • 3:已取消

taskResultCode

Integer

任务处理结果

  • 1:全部成功

  • 2:部分失败

  • 3:全部失败

resultCode

Integer

任务处理结果码

progress

Integer

任务进度。在异步任务中会返回，如打包下载任务

downloadUrl

String

下载链接。只有当任务类型为打包下载时才会用到

contentNum

Integer

请求文件数量

containerId

String

目标空间ID，跨空间场景时取目标空间ID

tenantId

String

租户标识

beginTime

String

任务开始时间

endTime

String

任务结束时间

createTime

String

任务创建时间
表6 TaskInfo

参数

参数类型

描述

id

String

Task标识

fileId

String

文件/目录ID

filePath

String

文件/目录的全路径，包含fileId

status

String

task处理状态，枚举值：

  • 0：待处理

  • 1：成功

  • 2：失败

newFileId

String

操作后的新ID

newFilePath

String

操作变更后的新路径

srcContainerId

String

源容器ID（file_id对应的源空间ID），仅批量复制任务跨空间时需要填写

resultCode

String

文件操作结果码

resultDesc

String

文件操作结果描述

tenantId

String

租户标识

createTime

String

Task创建时间
表7 UncompressedFileInfo

参数

参数类型

描述

containerId

String

解压后的空间ID，注：仅解压文件后返回

fileId

String

解压后的文件ID，注：仅解压文件后返回

name

String

文件或文件夹在压缩包内全路径

fileSize

Long

文件大小（单位B）

type

Integer

请参考文件类型fileType的定义

  • 1：内容

  • 2：目录

updatedAt

Long

文件修改毫秒时间戳

subFileList

UncompressedFileInfo object

子文件和子目录列表（仅对于目录时展开）

reason

String

失败原因（成功则空）

code

String

错误码

reservatioinInfo

Map<String,Object>

预留字段

状态码： 400

表8 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码： 401

表9 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

请求示例

查询某个批量操作任务的详情。

GET /koodrive/ose/v1/1309243162258308352

Authorization:Bearer+10f8***********a544791e9ff

响应示例

状态码： 200

返回查询到的任务详情

{
  "data" : {
    "jobInfo" : {
      "taskId" : "1309243162258308352",
      "userId" : "40086000004871666-369528171409614001",
      "taskType" : 1,
      "actionType" : 101,
      "status" : 2,
      "progress" : 100,
      "taskResultCode" : 1,
      "contentNum" : 1,
      "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
      "tenantId" : "40086000004871666",
      "beginTime" : "20231212095227",
      "endTime" : "20231212095227",
      "createTime" : "20231212095227"
    },
    "taskInfos" : [ {
      "fileId" : "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3",
      "status" : "1",
      "newFileId" : "FtEXHCpfqHueAHFbEmWZNkqUH_K866MVn",
      "srcContainerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"
    } ]
  },
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码

描述

200

返回查询到的任务详情

400

错误响应

401

鉴权失败

500

内部服务错误
父主题： 批量任务操作

相关文档