Task-列表

接口信息

  • 接口地址: {your-site-url}/api/skill/task/list
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
  • 请求方式: GET
  • 说明: 此接口用于获取 Task(计划任务)执行记录列表,支持按类型、状态筛选和分页。

认证

请求头中需要携带 skill-access-token

Header
skill-access-token {your-skill-access-token} (请替换为你自己的 token)

请求参数 (Query String)

字段 类型 必填 说明
type int Task 类型,code 值从 Task-类型列表 获取
status int Task 状态,code 值从 Task-状态列表 获取
pageNum int 页码,默认 1
pageSize int 每页条数,默认 20

请求示例

cURL

curl --location --request GET '{your-site-url}/api/skill/task/list' \
--header 'skill-access-token: {your-skill-access-token}'

返回结果

code200 表示调用成功;code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "list": [
            {
                "id": 2071,
                "shop_id": 15,
                "user_id": 1,
                "name": "批量编辑-商品",
                "status": 3,
                "type": 9,
                "begin_at": "2026-06-02 10:04:15",
                "end_at": "2026-06-02 10:04:17",
                "created_at": "2026-06-02 10:03:22",
                "updated_at": "2026-06-02 10:03:22",
                "plan_at": "2026-06-02 10:03:22",
                "progress": {
                    "prodbtmodify": {
                        "title": {
                            "cn": "商品批量编辑",
                            "tw": "商品批量編輯",
                            "en": "product modify"
                        },
                        "total": 1,
                        "progress": "1"
                    }
                }
            }
        ],
        "total": 1873,
        "pageSize": 20,
        "totalPage": 94
    },
    "message": "success"
}

返回字段说明

字段 类型 说明
code Number 状态码,200 表示成功
message String 执行结果的文字描述
data.list Array[Object] Task 记录列表
data.total int Task 总数
data.pageSize int 每页条数
data.totalPage int 总页数

list 子项字段

字段 类型 说明
id int Task 记录 ID
shop_id int 店铺 ID
user_id int 操作用户 ID
name string Task 名称
status int Task 状态。1 = 初始状态,2 = 处理中,3 = 完成,4 = 处理错误,5 = 手动终止
type int Task 类型 code,对应 Task-类型列表
plan_at string 计划执行时间
begin_at string 实际开始时间。0 表示未开始
end_at string 完成时间。0 表示未完成
created_at string 创建时间
updated_at string 最后更新时间
progress Object/Array 执行进度信息。当 status = 5(手动终止)或未开始执行时为空数组 [],正常执行时为包含各子任务进度的对象

progress 对象结构

progress 的每个子项(key)代表该 Task 的一个子流程,每个子流程包含:

字段 类型 说明
[key].title.cn string 子流程中文名称
[key].title.tw string 子流程繁体中文名称
[key].title.en string 子流程英文名称
[key].total int 子流程需要处理的数据总数
[key].progress string 子流程已经处理完成的数据数量

注意事项

  1. type 筛选值从 Task-类型列表code 获取
  2. status 筛选值从 Task-状态列表code 获取
  3. progress 可能为空数组(Task 未开始或被终止),或有多个子任务 key 的进度对象
Copyright © fecify.com 2025 all right reserved,powered by Gitbook该文件修订时间: 2026-06-04 14:13:26

results matching ""

    No results matching ""