Cron 定时任务
分页查询
GET/cron/v1/page
请求
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
type | string | 否 | 任务类型过滤,当前固定分为 user 和 system |
active | string<'0' | '1'> | 否 | 启用/禁用状态过滤 1 启用 | 0 禁用 ,默认不过滤 |
tags | string | 否 | 任务标签过滤(仅限系统任务,具体通过下方 获取标签列表 获取,支持多个用英文逗号分隔) |
search | string | 否 | 搜索内容过滤,过滤字段:name 、shell |
orderBy | string<'sort' | 'last_runtime' | 'last_run_use'> | 否 | 指定排序字段,默认 sort |
order | string<'0' | '1'> | 否 | 指定排序方式 0 升序 | 1 降序 ,默认降序 |
page | string | 否 | 指定页数,默认1 |
size | string | 否 | 指定分页大小数量,默认20 |
响应
名称 | 类型 | 描述 |
---|---|---|
data | object[] | 数据项 |
page | number | 当前页码 |
size | number | 每页数据量 |
total | number | 数据总量 |
点此展开查看具体响应数据示例
查询
请求
GET/cron/v1/query
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | string | 是 | 唯一标识 |
响应
参考上方分页查询接口响应
创建
POST/cron/v1/create
请求
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
name | string | 是 | 任务名称 |
cron | string | 是 | 定时表达式 |
shell | string | 是 | 执行的命令 |
active | number<0 | 1> | 否 | 状态 1启用 | 0禁用 ,默认启用 |
remark | string | 否 | 任务备注 |
config | string<object> | 否 | 高级配置 |
config
高级配置字段说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
before_task_shell | string | 否 | 任务运行前的执行命令 |
after_task_shell | string | 否 | 任务运行后的执行命令 |
log_directory | string | 否 | 日志目录路径(纯前端功能关联数据) |
source_file | string | 否 | 源码文件路径(纯前端功能关联数据) |
allow_concurrency | boolean | 否 | 是否允许并发 |
根据项目功能设计,开放接口目前只允许创建用户任务。
响应
参考上方分页查询接口响应
更新
POST/cron/v1/update
请求
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | number | 是 | 唯一标识 |
name | string | 否 | 任务名称 |
cron | string | 否 | 定时表达式 |
shell | string | 否 | 执行的命令 |
active | number<0 | 1> | 否 | 状态 1启用 | 0禁用 |
remark | string | 否 | 任务备注 |
config | string<object> | 否 | 高级配置,具体详见上方创建接口请求参数 |
响应
参考上方分页查询接口响应
删除
POST/cron/v1/delete
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | number | number[] | 是 | 唯一标识 |
调整排序
POST/cron/v1/order
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | number | 是 | 唯一标识 |
order | number | 否 | 目的修改位置 |
moveToEnd | boolean | 否 | 是否移动到最后 |
至少需要提供 order
或 moveToEnd
其中一个,设置 moveToEnd
时 order
参数的值会被覆盖为所有记录 sort
字段中的最大值,与其相反的操作是将 order
参数的值设置为 1
。关于置顶或置底操作应建立在可视角度上,后端分页数据默认均为倒序返回所以应注意区分使用场景。
获取标签列表
GET/cron/v1/tagsList
请求
无参数
响应
名称 | 类型 | 描述 |
---|---|---|
bind | string | 标签名称 |
count | string<number> | 累计使用该标签的任务数量 |
目前用于系统定时任务类型过滤,使用分页接口的
tags
参数,具体取自 bind
记录值的中间字段。查询运行中的任务
GET/cron/v1/runningTasks
请求
无参数
响应
参考上方分页查询接口响应
运行任务
POST/cron/v1/run
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | number | number[] | 是 | 唯一标识 |
主动运行和按照定时计划自动触发运行的过程大致相同,不过要注意区分后台管理面板设计的调试功能,该调试仅执行定时任务记录项所存储的
shell
字段命令,在运行完毕后不会更新定时任务的运行状态、最后运行时间等关键信息。终止任务
POST/cron/v1/terminate
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | number | number[] | 是 | 唯一标识 |
无法有效判断操作结果,因为存在少数任务进程没有被终止的异常情况,
is_running
字段的值在任务被终止后或正常运行完毕后才会更新。