Skip to main content

任务列表

获取用户创建的任务列表

接口URL​

GET: {base_url}/openapi/tasks

Headers​

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

请求参数​

参数类型必填参数说明示例
statusString任务状态
pending: 未开始   processing: 处理中   pause: 暂停
completed: 已完成   failed: 失败   deleted: 删除		pending
idString查找指定任务ID
created_fromString创建任务时间范围-开始，ISO-8601格式：YYYY-MM-DDTHH:mm:ss.sssZ如：2025-10-31T16:00:00.000Z为东八区25-11-01 00:00:00
created_toString创建任务时间范围-结束，ISO-8601格式：YYYY-MM-DDTHH:mm:ss.sssZ如：2025-11-30T16:00:00.000Z为东八区25-12-01 00:00:00
sortByString排序字段，status, progress, created_at, start_at, completed_at默认按created_at创建任务时间排序
sortOrderString排序顺序 desc: 降序, asc: 升序默认desc
分页参数⬇️
pageString第几页数据，默认为11
limitString每页多少条数据，默认为10，如要一次拉取范围内全部数据，则设个超大值99999910

请求示例​

curl -X GET '{base_url}/openapi/tasks?status=processing' \
--header 'Authorization: Bearer <API令牌>'

响应参数​

字段类型说明
codeInteger0: 业务正常响应，其他为异常
timestampInteger响应时间戳，单位秒
msgstring异常信息
dataobject业务数据
├ tasksarray任务列表
└ paginationobject分页数据

响应示例​

成功

{
    "code": 0,
    "timestamp": 1755074718,
    "data": {
        "tasks": [
            {
                // 任务ID
                "id": "xxxxxxxx",
                // 提交的任务文件名
                "file_name": "text_8_13.xlsx",
                // 提交的任务文件，下载地址取 base_url 进行拼接，如：`${base_url}${file_path}`
                "file_path": "/taskUploads/xxxxxxxx/xxxxxxxx.xlsx",
                // 任务完成后导出的数据压缩包，下载地址取 base_url 进行拼接
                "items_path": "/taskUploads/xxxxxxxx/xxxxxxxx.zip",
                // 任务需抓取的商品总数
                "total_items": 5,
                // 当前任务进度 (0~100)
                "progress": 100,
                // 当前任务状态，pending: 未开始, processing: 处理中, pause: 暂停中, completed: 已完成, failed: 失败
                "status": "completed",
                // 任务创建时间
                "created_at": "2025-08-13T07:01:53.000951+00:00",
                // 任务开始时间
                "start_at": "2025-08-13T07:02:00.293+00:00",
                // 任务完成时间
                "completed_at": "2025-08-13T07:02:15.574+00:00",
                "user_id": "xxxxx",
                "user_email": "[email protected]",
                "user_name": null,
                // 任务创建方式，"api": 通过 openapi 接口创建，"website": 通过网页创建
                "created_src": "website"
            },
        ],
        "pagination": {
            "page": 1,
            "limit": 10,
            "total": 14,
            "totalPages": 2
        }
    }
}

异常数据结构示例

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