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

查询批量操作任务详情

功能介绍

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

URI

GET /koodrive/ose/v1/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

批量任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取

x-trace-id

否

String

消息日志跟踪标识

X-Csrf-Token

是

String

CSRF Token

language

否

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应消息

data

data object

任务详情
表4 data

参数

参数类型

描述

jobInfo

JobInfo object

任务信息

taskInfos

Array of TaskInfo objects

Task详情列表
表5 JobInfo

参数

参数类型

描述

taskId

String

任务标识

taskName

String

任务名称

userId

String

任务创建者的用户ID

taskType

Integer

任务类型

actionType

Integer

操作类型

status

Integer

任务状态

taskResultCode

Integer

任务处理结果

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创建时间

状态码： 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

任务跟踪的请求ID号
表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

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

GET /koodrive/ose/v1/1309243162258308352

Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff
X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5

响应示例

状态码： 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

错误响应
父主题： 批量任务操作
分享：

    相关文档

    相关产品