跳至主要內容

task

Andy HsuGuideAPIGuide大约 7 分钟

task

alist中的任务管理可以分为:

接口名说明
/upload上传任务
/copy复制任务
/offline_download离线下载任务
/offline_download_transfer离线下载转存任务

每种任务都有以下接口:

  • info
  • done
  • undone
  • delete
  • cancel
  • clear_done
  • clear_succeeded
  • retry
  • retry_failed
  • delete_some
  • cancel_some
  • retry_some

下面将以upload任务为例,说明每个接口的作用。

POST 获取任务信息

POST /api/task/upload/info

请求参数

名称位置类型必选说明
tidquerystringno任务id
Authorizationheaderstringyesnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "1",
      "name": "upload 1.png to [/s](/test)",
      "creator": "admin",
      "creator_role": 2,
      "state": "succeeded",
      "status": "",
      "progress": 100,
      "start_time": "2024-12-30T18:32:12.4250369+08:00",
      "end_time": "2024-12-30T18:32:15.7954633+08:00",
      "total_bytes": 15273462,
      "error": ""
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» data[object]truenonenone
»» idstringfalsenoneidnone
»» namestringfalsenone任务名none
»» creatorstringfalsenone任务创建者用户名none
»» creator_roleintegerfalsenone任务创建者角色0: 普通用户,1: 访客,2: 管理员
»» statestringfalsenone任务完成状态none
»» statusstringfalsenonenone
»» progressfloatfalsenone进度none
»» start_timestring | nullfalsenone任务开始时间为null表示任务未开始
»» end_timestring | nullfalsenone任务结束时间为null表示任务未结束
»» total_bytesintegerfalsenone总传输字节数任务开始之前可能为0
»» errorstringfalsenone错误信息none

GET 获取已完成任务

GET /api/task/upload/done

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "1",
      "name": "upload 1.png to [/s](/test)",
      "creator": "example_user",
      "creator_role": 0,
      "state": "succeeded",
      "status": "",
      "progress": 100,
      "start_time": "2024-12-30T18:32:12.4250369+08:00",
      "end_time": "2024-12-30T18:32:15.7954633+08:00",
      "total_bytes": 15273462,
      "error": ""
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» data[object]truenonenone
»» idstringfalsenoneidnone
»» namestringfalsenone任务名none
»» creatorstringfalsenone任务创建者用户名none
»» creator_roleintegerfalsenone任务创建者角色0: 普通用户,1: 访客,2: 管理员
»» statestringfalsenone任务完成状态none
»» statusstringfalsenonenone
»» progressfloatfalsenone进度none
»» start_timestringfalsenone任务开始时间none
»» end_timestringfalsenone任务结束时间none
»» total_bytesintegerfalsenone总传输字节数none
»» errorstringfalsenone错误信息none

GET 获取未完成任务

GET /api/task/upload/undone

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "1",
      "name": "upload 1.png to [/s](/test)",
      "creator": "guest",
      "creator_role": 1,
      "state": "succeeded",
      "status": "",
      "progress": 50,
      "start_time": "2024-12-30T18:32:12.4250369+08:00",
      "end_time": null,
      "total_bytes": 15273462,
      "error": ""
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» data[object]truenonenone
»» idstringfalsenoneidnone
»» namestringfalsenone任务名none
»» creatorstringfalsenone任务创建者用户名none
»» creator_roleintegerfalsenone任务创建者角色0: 普通用户,1: 访客,2: 管理员
»» statestringfalsenone任务完成状态none
»» statusstringfalsenonenone
»» progressfloatfalsenone进度none
»» start_timestring | nullfalsenone任务开始时间为null表示任务未开始
»» end_timenullfalsenone任务结束时间none
»» total_bytesintegerfalsenone总传输字节数任务开始之前可能为0
»» errorstringfalsenone错误信息none

POST 删除任务

POST /api/task/upload/delete

请求参数

名称位置类型必选说明
tidquerystring任务id
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 取消任务

POST /api/task/upload/cancel

请求参数

名称位置类型必选说明
tidquerystring任务id
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 清除已完成任务

POST /api/task/upload/clear_done

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 清除已成功任务

POST /api/task/upload/clear_succeeded

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 重试任务

POST /api/task/upload/retry

请求参数

名称位置类型必选说明
tidquerystring任务id
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 重试已失败任务

POST /api/task/upload/retry_failed

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 删除多个任务

POST /api/task/upload/delete_some

请求参数

名称位置类型必选说明
Authorizationheaderstringnone
bodybody[string]任务id

请求体示例

[ "WC7gsoTr5CHkExN9dmyxs", "bcv4U-79gv1c6hB_DPOk_" ]

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "bcv4U-79gv1c6hB_DPOk_": "task not found"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenone不在此对象中的任务表示删除成功且无错误信息
»» 任务idstringfalsenone错误信息none

POST 取消多个任务

POST /api/task/upload/cancel_some

请求参数

名称位置类型必选说明
Authorizationheaderstringnone
bodybody[string]任务id

请求体示例

[ "WC7gsoTr5CHkExN9dmyxs", "bcv4U-79gv1c6hB_DPOk_" ]

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "bcv4U-79gv1c6hB_DPOk_": "task not found"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenone不在此对象中的任务表示取消成功且无错误信息
»» 任务idstringfalsenone错误信息none

POST 重试多个任务

POST /api/task/upload/retry_some

请求参数

名称位置类型必选说明
Authorizationheaderstringnone
bodybody[string]任务id

请求体示例

[ "WC7gsoTr5CHkExN9dmyxs", "bcv4U-79gv1c6hB_DPOk_" ]

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "bcv4U-79gv1c6hB_DPOk_": "task not found"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenone不在此对象中的任务表示重试成功且无错误信息
»» 任务idstringfalsenone错误信息none