Skip to main content

任务操作

变更任务状态

接口URL​

PATCH: {base_url}/openapi/tasks/<TaskID>

Headers​

参数参数说明
AuthorizationBearer <API令牌>

请求参数​

1、开始任务

{
    "status": "processing"
}

2、暂停任务

{
    "status": "pause"
}

3、取消任务

{
    "status": "failed"
}

4、删除任务

{
    "is_deleted": 1
}

5、更新任务优先级

{
    "priority": 8
}

6、更新任务备注

{
    "remark": "备注"
}

响应示例​

成功

{
    "code": 0,
    "timestamp": 1763564932,
    "data": {
        "id": "2fa49d6c37",
        "file_name": "2fa49d6c37.json",
        "file_path": "/taskUploads/2fa49d6c37/2fa49d6c37.json",
        "record_path": "/taskUploads/2fa49d6c37/record.json",
        "items_path": null,
        "total_items": 7,
        "progress": 0,
        "status": "failed",
        "priority": 0,
        "created_at": "2025-08-11T14:32:49.488753+00:00",
        "start_at": "2025-11-19T14:50:14.181+00:00",
        "completed_at": null,
        "user_id": "d28439b8-6d1e-48fe-9485-c85b293bff2f",
        "user_email": "admin@xxx.xxx",
        "user_name": "admin",
        "created_src": "api",
        "remark": "备注",
        "is_deleted": 0
    }
}

异常数据结构示例

{
    "code": 401,
    "msg": "身份验证失败: 无效的API令牌",
    "timestamp": 1755074441
}