Skip to content

Commit 96a05f9

Browse files
KirCuteKirCute
authored
docs(task): update docs (#392)
* docs(task): update docs * fix(docs): /api/admin/task move to /api/task * docs(task): AlistGo/alist#7655 * fix
1 parent c0a0c91 commit 96a05f9

File tree

4 files changed

+1226
-752
lines changed

4 files changed

+1226
-752
lines changed

‎docs/guide/api/admin/task.md

Lines changed: 3 additions & 376 deletions
Original file line numberDiff line numberDiff line change
@@ -14,384 +14,11 @@ tag:
1414
# this page is sticky in article list
1515
sticky: true
1616
# this page will appear in starred articles
17-
star: true
17+
star: false
1818
---
1919

2020
# task
2121

22-
alist中的任务管理可以分为：
22+
本 API 现已移至`/api/task`，`/api/admin/task`仅出于兼容目的保留
2323

24-
| 接口名 | 说明 |
25-
| --------------- | ------------- |
26-
| /upload | 上传任务 |
27-
| /copy | 复制任务 |
28-
| /aria2_down | aria2下载任务 |
29-
| /aria2_transfer | aria2转存任务 |
30-
| /qbit_down | qbit下载任务 |
31-
| /qbit_transfer | qbit转存任务 |
32-
33-
每种任务都有以下接口：
34-
35-
- info
36-
- done
37-
- undone
38-
- delete
39-
- cancel
40-
- clear_done
41-
- clear_succeeded
42-
- retry
43-
44-
下面将以upload任务为例，说明每个接口的作用。
45-
46-
## POST 获取任务信息
47-
48-
POST /api/admin/task/upload/info
49-
50-
### 请求参数
51-
52-
| 名称 | 位置 | 类型 | 必选 | 说明 |
53-
| ------------- | ------ | ------ | ---- | ------ |
54-
| tid | query | string | no | 任务id |
55-
| Authorization | header | string | yes | none |
56-
57-
### 返回示例
58-
59-
> 成功
60-
61-
```json
62-
{
63-
"code": 200,
64-
"message": "success",
65-
"data": [
66-
{
67-
"id": "1",
68-
"name": "upload 1.png to [/s](/test)",
69-
"state": "succeeded",
70-
"status": "",
71-
"progress": 100,
72-
"error": ""
73-
}
74-
]
75-
}
76-
```
77-
78-
### 返回结果
79-
80-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
81-
| ------ | ------------------------------------------------------- | ---- | -------- |
82-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
83-
84-
### 返回数据结构
85-
86-
状态码 **200**
87-
88-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
89-
| ----------- | -------- | ----- | ---- | ------------ | ---- |
90-
| » code | integer | true | none | 状态码 | none |
91-
| » message | string | true | none | 信息 | none |
92-
| » data | [object] | true | none | | none |
93-
| »» id | string | false | none | id | none |
94-
| »» name | string | false | none | 任务名 | none |
95-
| »» state | string | false | none | 任务完成状态 | none |
96-
| »» status | string | false | none | | none |
97-
| »» progress | integer | false | none | 进度 | none |
98-
| »» error | string | false | none | 错误信息 | none |
99-
100-
## GET 获取已完成任务
101-
102-
GET /api/admin/task/upload/done
103-
104-
### 请求参数
105-
106-
| 名称 | 位置 | 类型 | 必选 | 说明 |
107-
| ------------- | ------ | ------ | ---- | ---- |
108-
| Authorization | header | string | 是 | none |
109-
110-
### 返回示例
111-
112-
> 成功
113-
114-
```json
115-
{
116-
"code": 200,
117-
"message": "success",
118-
"data": [
119-
{
120-
"id": "1",
121-
"name": "upload 1.png to [/s](/test)",
122-
"state": "succeeded",
123-
"status": "",
124-
"progress": 100,
125-
"error": ""
126-
}
127-
]
128-
}
129-
```
130-
131-
### 返回结果
132-
133-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
134-
| ------ | ------------------------------------------------------- | ---- | -------- |
135-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
136-
137-
### 返回数据结构
138-
139-
状态码 **200**
140-
141-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
142-
| ----------- | -------- | ----- | ---- | ------------ | ---- |
143-
| » code | integer | true | none | 状态码 | none |
144-
| » message | string | true | none | 信息 | none |
145-
| » data | [object] | true | none | | none |
146-
| »» id | string | false | none | id | none |
147-
| »» name | string | false | none | 任务名 | none |
148-
| »» state | string | false | none | 任务完成状态 | none |
149-
| »» status | string | false | none | | none |
150-
| »» progress | integer | false | none | 进度 | none |
151-
| »» error | string | false | none | 错误信息 | none |
152-
153-
## GET 获取未完成任务
154-
155-
GET /api/admin/task/upload/undone
156-
157-
### 请求参数
158-
159-
| 名称 | 位置 | 类型 | 必选 | 说明 |
160-
| ------------- | ------ | ------ | ---- | ---- |
161-
| Authorization | header | string | 是 | none |
162-
163-
### 返回示例
164-
165-
> 成功
166-
167-
```json
168-
{
169-
"code": 200,
170-
"message": "success",
171-
"data": [
172-
{
173-
"id": "1",
174-
"name": "upload 1.png to [/s](/test)",
175-
"state": "succeeded",
176-
"status": "",
177-
"progress": 100,
178-
"error": ""
179-
}
180-
]
181-
}
182-
```
183-
184-
### 返回结果
185-
186-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
187-
| ------ | ------------------------------------------------------- | ---- | -------- |
188-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
189-
190-
### 返回数据结构
191-
192-
状态码 **200**
193-
194-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
195-
| ----------- | -------- | ----- | ---- | ------------ | ---- |
196-
| » code | integer | true | none | 状态码 | none |
197-
| » message | string | true | none | 信息 | none |
198-
| » data | [object] | true | none | | none |
199-
| »» id | string | false | none | id | none |
200-
| »» name | string | false | none | 任务名 | none |
201-
| »» state | string | false | none | 任务完成状态 | none |
202-
| »» status | string | false | none | | none |
203-
| »» progress | integer | false | none | 进度 | none |
204-
| »» error | string | false | none | 错误信息 | none |
205-
206-
## POST 删除任务
207-
208-
POST /api/admin/task/upload/delete
209-
210-
### 请求参数
211-
212-
| 名称 | 位置 | 类型 | 必选 | 说明 |
213-
| ------------- | ------ | ------ | ---- | ------ |
214-
| tid | query | string | 是 | 任务id |
215-
| Authorization | header | string | 是 | none |
216-
217-
### 返回示例
218-
219-
> 成功
220-
221-
```json
222-
{
223-
"code": 200,
224-
"message": "success",
225-
"data": null
226-
}
227-
```
228-
229-
### 返回结果
230-
231-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
232-
| ------ | ------------------------------------------------------- | ---- | -------- |
233-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
234-
235-
### 返回数据结构
236-
237-
状态码 **200**
238-
239-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
240-
| --------- | ------- | ---- | ---- | ------ | ---- |
241-
| » code | integer | true | none | 状态码 | none |
242-
| » message | string | true | none | 信息 | none |
243-
| » data | null | true | none | | none |
244-
245-
## POST 取消任务
246-
247-
POST /api/admin/task/upload/cancel
248-
249-
### 请求参数
250-
251-
| 名称 | 位置 | 类型 | 必选 | 说明 |
252-
| ------------- | ------ | ------ | ---- | ------ |
253-
| tid | query | string | 是 | 任务id |
254-
| Authorization | header | string | 是 | none |
255-
256-
### 返回示例
257-
258-
> 成功
259-
260-
```json
261-
{
262-
"code": 200,
263-
"message": "success",
264-
"data": null
265-
}
266-
```
267-
268-
### 返回结果
269-
270-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
271-
| ------ | ------------------------------------------------------- | ---- | -------- |
272-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
273-
274-
### 返回数据结构
275-
276-
状态码 **200**
277-
278-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
279-
| --------- | ------- | ---- | ---- | ------ | ---- |
280-
| » code | integer | true | none | 状态码 | none |
281-
| » message | string | true | none | 信息 | none |
282-
| » data | null | true | none | | none |
283-
284-
## POST 清除已完成任务
285-
286-
POST /api/admin/task/upload/clear_done
287-
288-
### 请求参数
289-
290-
| 名称 | 位置 | 类型 | 必选 | 说明 |
291-
| ------------- | ------ | ------ | ---- | ---- |
292-
| Authorization | header | string | 是 | none |
293-
294-
### 返回示例
295-
296-
> 成功
297-
298-
```json
299-
{
300-
"code": 200,
301-
"message": "success",
302-
"data": null
303-
}
304-
```
305-
306-
### 返回结果
307-
308-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
309-
| ------ | ------------------------------------------------------- | ---- | -------- |
310-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
311-
312-
### 返回数据结构
313-
314-
状态码 **200**
315-
316-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
317-
| --------- | ------- | ---- | ---- | ------ | ---- |
318-
| » code | integer | true | none | 状态码 | none |
319-
| » message | string | true | none | 信息 | none |
320-
| » data | null | true | none | | none |
321-
322-
## POST 清除已成功任务
323-
324-
POST /api/admin/task/upload/clear_succeeded
325-
326-
### 请求参数
327-
328-
| 名称 | 位置 | 类型 | 必选 | 说明 |
329-
| ------------- | ------ | ------ | ---- | ---- |
330-
| Authorization | header | string | 是 | none |
331-
332-
### 返回示例
333-
334-
> 成功
335-
336-
```json
337-
{
338-
"code": 200,
339-
"message": "success",
340-
"data": null
341-
}
342-
```
343-
344-
### 返回结果
345-
346-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
347-
| ------ | ------------------------------------------------------- | ---- | -------- |
348-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
349-
350-
### 返回数据结构
351-
352-
状态码 **200**
353-
354-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
355-
| --------- | ------- | ---- | ---- | ------ | ---- |
356-
| » code | integer | true | none | 状态码 | none |
357-
| » message | string | true | none | 信息 | none |
358-
| » data | null | true | none | | none |
359-
360-
## POST 重试任务
361-
362-
POST /api/admin/task/upload/retry
363-
364-
### 请求参数
365-
366-
| 名称 | 位置 | 类型 | 必选 | 说明 |
367-
| ------------- | ------ | ------ | ---- | ------ |
368-
| tid | query | string | 是 | 任务id |
369-
| Authorization | header | string | 是 | none |
370-
371-
### 返回示例
372-
373-
> 成功
374-
375-
```json
376-
{
377-
"code": 200,
378-
"message": "success",
379-
"data": null
380-
}
381-
```
382-
383-
### 返回结果
384-
385-
| 状态码 | 状态码含义 | 说明 | 数据模型 |
386-
| ------ | ------------------------------------------------------- | ---- | -------- |
387-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
388-
389-
### 返回数据结构
390-
391-
状态码 **200**
392-
393-
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
394-
| --------- | ------- | ---- | ---- | ------ | ---- |
395-
| » code | integer | true | none | 状态码 | none |
396-
| » message | string | true | none | 信息 | none |
397-
| » data | null | true | none | | none |
24+
另见[/api/task](/guide/api/task.html)

0 commit comments

Comments
 (0)