mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-28 03:06:38 +08:00
truewhile
105 lines
2.8 KiB
Markdown
105 lines
2.8 KiB
Markdown
## 清空云下载任务
|
|
|
|
### 基本信息
|
|
|
|
| 属性 | 内容 |
|
|
|:-------------|:----------------------------------|
|
|
| 接口名称 | 清空云下载任务 |
|
|
| 接口版本 | v1.0 |
|
|
| 接口路径 | /clear_task |
|
|
| 请求方法 | POST |
|
|
| 接口状态 | 生产环境 |
|
|
|
|
### 接口说明
|
|
|
|
按指定类型清空当前授权用户的云下载任务。
|
|
|
|
### 接口地址
|
|
|
|
```
|
|
https://proapi.115.com/open/offline/clear_task
|
|
```
|
|
|
|
### 请求方式
|
|
|
|
```
|
|
POST
|
|
Content-Type: multipart/form-data
|
|
```
|
|
|
|
### 认证方式
|
|
|
|
```
|
|
Authorization: Bearer access_token
|
|
```
|
|
|
|
### 请求参数
|
|
|
|
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
|
|:-------|:-----|:-----|:-------|:-----------------------|:----------|
|
|
| flag | int | 是 | - | 清空任务类型，见下方枚举表格 | 1 |
|
|
|
|
#### 请求参数中的 flag 参数枚举
|
|
|
|
| 值 | 说明 | 备注 |
|
|
|:---|:-----------------------------|:-----|
|
|
| 0 | 清空已完成任务 | - |
|
|
| 1 | 清空全部任务 | - |
|
|
| 2 | 清空失败任务 | - |
|
|
| 3 | 清空进行中任务 | - |
|
|
| 4 | 清空已完成任务并删除对应源文件 | - |
|
|
| 5 | 清空全部任务并删除对应源文件 | - |
|
|
|
|
### 请求示例
|
|
|
|
```shell
|
|
curl 'https://proapi.115.com/open/offline/clear_task' \
|
|
-H 'Authorization: Bearer <access_token>' \
|
|
--form-string 'flag=1'
|
|
```
|
|
|
|
### 响应字段说明
|
|
|
|
| 字段 | 类型 | 描述 |
|
|
|:--------|:--------|:-----------------|
|
|
| state | boolean | 操作结果状态 |
|
|
| message | string | 返回信息 |
|
|
| code | int | 错误码 |
|
|
| data | object[] | 返回数据，成功时为空数组 |
|
|
|
|
#### 响应的 code 字段(错误码)说明
|
|
|
|
| 错误码 | 说明 | 解决方案 |
|
|
|:-------|:---------|:--------------------------|
|
|
| 990002 | 参数错误 | 检查 `flag` 是否为0至5的整数 |
|
|
|
|
### 响应示例
|
|
|
|
```json
|
|
{
|
|
"state": true,
|
|
"message": "",
|
|
"code": 0,
|
|
"data": []
|
|
}
|
|
```
|
|
|
|
### 业务规则
|
|
|
|
- `flag=4` 或 `flag=5` 会同时删除对应源文件，操作前需确认清理范围。
|
|
|
|
### 性能与安全说明
|
|
|
|
- 用户身份由 Bearer access_token 解析，请求参数不能指定115账号。
|
|
- 接口按应用、用户和接口维度执行频率限制。
|
|
|
|
### 注意事项
|
|
|
|
- 清空结果以响应中的 `state`、`code` 和 `message` 字段为准。
|
|
|
|
### 修改历史
|
|
|
|
| 修改时间 | 修改说明 |
|
|
|:-----------------------------|:-----|
|
|
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|