后台任务

3 endpoints.

清除全部已完成任务

DELETEhttp://localhost:3000/api/jobs

移除已到达终止状态的任务——finished 或 failed。仍在进行中（queued、active）的任务保持被跟踪；等它们结束后再用单项端点处理。

只接受 state=finished。这个名字的含义是「任何处于终止状态的任务」，所以 failed 的也会被一并清掉。

查询参数

statestring · enum: finished必填: 只接受 finished；缺失或传入其他值会返回 400。

响应

200清除了多少个任务。

null

400`state` 缺失，或者不是 `finished`。

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

statequery

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。

列出正在跟踪的后台任务

GEThttp://localhost:3000/api/jobs

本实例正在跟踪的每一个任务，最新的在前。

进度与字节数是尽力而为的：无法报告细粒度进度的任务会直接从 0 跳到 1，而不是伪造一个中间值；对于没有传输可报告的任务，字节字段是真正的缺失（而不是 0）。

响应

200当前任务列表。

{
  "jobs": [
    {
      "downloaded_bytes": null,
      "error": null,
      "finished_at": null,
      "id": null,
      "name": null,
      "progress": null,
      "rate_limit_bytes_per_sec": null,
      "rate_limit_matched_pattern": null,
      "result": null,
      "result_truncated": null,
      "started_at": null,
      "state": null,
      "total_bytes": null
    }
  ]
}

服务器地址API 令牌

填写你自己的实例地址，请求由浏览器直接发往该地址。

清除单个任务

DELETEhttp://localhost:3000/api/jobs/{id}

按 ID 清除单个任务，且只在该任务已到达终止状态后进行。

仍处于 queued 或 active 的任务会返回 409，而不是被悄悄杀掉——一个工作还在跑却报告成功的任务，比一个错误更糟。

路径参数

idstring必填

响应

200已清除。

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

404没有在跟踪该 ID 的任务。

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

409该任务仍在排队或执行中；请等它结束或失败后再操作。

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

idpath

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。