查询批量操作任务列表 - GetJobList
功能介绍
查询批量操作任务列表。
授权信息
当前API调用无需身份策略权限。
URI
GET /koodrive/ose/v1/jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 否 | Integer | 参数解释: 任务类型 约束限制: 枚举值 1:批量复制任务 2:批量删除任务 3:批量移动任务 4:批量还原回收站 5:云解压(数据文件需要加载到新加坡节点进行处理) 7:清空回收站 取值范围: 详见枚举值 默认值: 不涉及 |
| status | 否 | Integer | 参数解释: 任务状态 约束限制: 枚举值 取值范围: 0-3 默认值: 不涉及 |
| offset | 是 | Integer | 参数解释: 数据查询的偏移量 约束限制: 大于0 无最大值限制 取值范围: 大于0 无最大值限制 默认值: 不涉及 |
| limit | 是 | Integer | 参数解释: 最大返回个数 约束限制: 不涉及 取值范围: 最小值为1,最大值为100 默认值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 符合i18n规范 默认取值: en-US |
| X-User-Id | 是 | String | 参数解释: KooDrive侧用户id,用于app鉴权 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Date | 是 | String | 参数解释: 日期,用于app鉴权 约束限制: 日期格式:yyyyMMDD'T'HHmmss'Z' ; 例如20251103T070140Z 取值范围: 距当前时间15分钟以内,不能晚于当前时间 默认值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应消息 |
| data | Array of JobInfo objects | 批量任务列表信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| taskId | String | 任务标识 |
| taskType | Integer | 任务类型 |
| actionType | Integer | 操作类型 |
| status | Integer | 任务状态 |
| taskResultCode | Integer | 任务处理结果 |
| resultCode | Integer | 任务处理结果码 |
| contentNum | Integer | 请求文件数量 |
| containerId | String | 目标空间ID,跨空间场景时取目标空间ID |
| tenantId | String | 租户标识 |
| beginTime | String | 任务开始时间 |
| endTime | String | 任务结束时间 |
| createTime | String | 任务创建时间 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应描述 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应描述 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应描述 |
请求示例
查询批量操作任务列表请求示例。
GET /koodrive/ose/v1/jobs?offset=0&limit=2 Authorization:Bearer+10f88*************5a544791e9ff
响应示例
状态码:200
返回查询到的任务列表
{
"data" : [ {
"taskId" : "1320279189273965056",
"taskType" : 2,
"actionType" : 201,
"status" : 2,
"taskResultCode" : 1,
"contentNum" : 1,
"containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236",
"beginTime" : "20231227151904",
"endTime" : "20231227151904",
"createTime" : "20231227151904"
}, {
"taskId" : "1320279092268104960",
"taskType" : 2,
"actionType" : 201,
"status" : 2,
"taskResultCode" : 1,
"contentNum" : 4,
"containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236",
"beginTime" : "20231227151852",
"endTime" : "20231227151852",
"createTime" : "20231227151852"
} ],
"code" : 0,
"msg" : "成功"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回查询到的任务列表 |
| 400 | 错误响应 |
| 401 | 鉴权失败 |
| 500 | 内部服务错误 |