Skip to main content

task

Andy HsuGuideADMINAPIGuideAbout 4 min

task

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

接口名说明
/upload上传任务
/copy复制任务
/aria2_downaria2下载任务
/aria2_transferaria2转存任务
/qbit_downqbit下载任务
/qbit_transferqbit转存任务

每种任务都有以下接口:

  • info
  • done
  • undone
  • delete
  • cancel
  • clear_done
  • clear_succeeded
  • retry

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

POST 获取任务信息

POST /api/admin/task/upload/info

请求参数

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

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "1",
      "name": "upload 1.png to [/s](/test)",
      "state": "succeeded",
      "status": "",
      "progress": 100,
      "error": ""
    }
  ]
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» data[object]truenonenone
»» idstringfalsenoneidnone
»» namestringfalsenone任务名none
»» statestringfalsenone任务完成状态none
»» statusstringfalsenonenone
»» progressintegerfalsenone进度none
»» errorstringfalsenone错误信息none

GET 获取已完成任务

GET /api/admin/task/upload/done

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "1",
      "name": "upload 1.png to [/s](/test)",
      "state": "succeeded",
      "status": "",
      "progress": 100,
      "error": ""
    }
  ]
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» data[object]truenonenone
»» idstringfalsenoneidnone
»» namestringfalsenone任务名none
»» statestringfalsenone任务完成状态none
»» statusstringfalsenonenone
»» progressintegerfalsenone进度none
»» errorstringfalsenone错误信息none

GET 获取未完成任务

GET /api/admin/task/upload/undone

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": "1",
      "name": "upload 1.png to [/s](/test)",
      "state": "succeeded",
      "status": "",
      "progress": 100,
      "error": ""
    }
  ]
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» data[object]truenonenone
»» idstringfalsenoneidnone
»» namestringfalsenone任务名none
»» statestringfalsenone任务完成状态none
»» statusstringfalsenonenone
»» progressintegerfalsenone进度none
»» errorstringfalsenone错误信息none

POST 删除任务

POST /api/admin/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/admin/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/admin/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/admin/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/admin/task/upload/retry

请求参数

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

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

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