yzh52521/http-crontab

接口化秒级定时任务管理

Maintainers

Details

github.com/yzh52521/http-crontab

Source

Issues

Installs: 235

Dependents: 0

Suggesters: 0

Security: 0

Stars: 7

Watchers: 3

Forks: 2

v1.33 2023-09-01 09:33 UTC

Requires

Requires (Dev)

Apache-2.0 febe2a11739cbd6d2562da6650858f6db6626640

  • yzh52521 <396751927.woop@qq.com>

httpcrontab

This package is auto-updated.

Last update: 2024-04-14 04:26:18 UTC

README

概述

基于 Workerman + ThinkPHP6.x/8.x 的接口化秒级定时任务管理，兼容 Windows 和 Linux 系统。

定时器格式说明：

0   1   2   3   4   5
|   |   |   |   |   |
|   |   |   |   |   +------ day of week (0 - 6) (Sunday=0)
|   |   |   |   +------ month (1 - 12)
|   |   |   +-------- day of month (1 - 31)
|   |   +---------- hour (0 - 23)
|   +------------ min (0 - 59)
+-------------- sec (0-59)[可省略，如果没有0位,则最小时间粒度是分钟]

任务分类

  • url 任务可以指定一个url地址来请求，没有什么可解释的。

  • Class 任务必须指定带有 命名空间的类名，并且实现一个 public 属性的方法：execute 方法返回值为 bool/string类型，支持自定义方法 事例：target='app\common\model\User@check' @后面是方法

  • Command 任务请先按照 thinkphp 官方文档定义好执行命令，在新增任务，输入定义的 命令 即可 例如：version

  • Shell 任务 在新增任务，输入定义的 shell命令 即可 例如：ps -ef | grep php

简单使用

启动服务

效果图

定时器接口说明

PING

基本信息

Path： /crontab/ping

Method： GET

接口描述：

{
     "code": 200,
     "data": "pong",
     "msg": "信息调用成功！"
}

请求参数

返回数据

名称类型 是否必须 默认值 备注 其他信息
codenumber非必须
datastring非必须
msgstring非必须

修改

基本信息

Path： /crontab/modify

Method： POST

接口描述：

{
  "code": 200,
  "data": true,
  "msg": "信息调用成功！"
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1
field text 是 status 字段[status; sort; remark; title,rule]
value text 是 1 值

列表

基本信息

Path： /crontab/index

Method： GET

接口描述：

{
  "code": 200,
  "data": {
    "total": 4,
    "data": [
      {
        "id": 1,
        "title": "输出 tp 版本",
        "type": 1,
        "rule": "*/3 * * * * *",
        "target": "version",
        "parameter": "",
        "running_times": 3,
        "last_running_time": 1625636646,
        "remark": "每3秒执行",
        "sort": 0,
        "status": 1,
        "singleton": 1,
        "create_time": 1625636609,
        "update_time": 1625636609
      },
        {
        "id": 2,
        "title": "class任务 每月1号清理所有日志",
        "type": 2,
        "rule": "0 0 1 * *",
        "target": "app\\common\\crontab\\ClearLogCrontab",
        "parameter": "",
        "running_times": 71,
        "last_running_time": 1651121710,
        "remark": "",
        "sort": 0,
        "status": 1,
        "create_time": 1651114277,
        "update_time": 1651114277,
        "singleton": 1
        },
    ],
  },
  "msg": "信息调用成功！"
}

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码
limit 是 15 每页条数
filter 否 {"title":"输出 tp 版本"} 检索字段值
op 否 {"title":"%*%"} 检索字段操作

删除

基本信息

Path： /crontab/delete

Method： POST

接口描述：

{
     "code": 200,
     "data": true,
     "msg": "信息调用成功！"
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1,2

定时器池

基本信息

Path： /crontab/pool

Method： GET

接口描述：

"code": 200,
"data": [
 {
   "id": 1,
   "type": 1,
   "target": "version",
   "rule": "*/3 * * * * *",
   "parameter": "",
   "remark": "每3秒执行",
   "singleton":1,
   "create_time": "2021-07-07 13:43:29"
 }
],
 "msg": "信息调用成功！"
}

请求参数

日志

基本信息

Path： /crontab/flow

Method： GET

接口描述：

{
  "code": 200,
  "msg": "ok",
  "data": {
    "total": 97,
    "data": [
      {
        "id": 257,
        "crontab_id": 1,
        "target": "version",
        "parameter": "",
        "exception": "v6.0.12LTS",
        "return_code": 0,
        "running_time": "0.834571",
        "create_time": 1651123800,
        "update_time": 1651123800
      },
      {
        "id": 251,
        "crontab_id": 1,
        "target": "version",
        "parameter": "",
        "exception": "v6.0.12LTS",
        "return_code": 0,
        "running_time": "0.540384",
        "create_time": 1651121700,
        "update_time": 1651121700
      },
      {
        "id": 246,
        "crontab_id": 1,
        "target": "version",
        "parameter": "",
        "exception": "v6.0.12LTS",
        "return_code": 0,
        "running_time": "0.316019",
        "create_time": 1651121640,
        "update_time": 1651121640
      },
      {
        "id": 244,
        "crontab_id": 1,
        "target": "version",
        "parameter": "",
        "exception": "v6.0.12LTS",
        "return_code": 0,
        "running_time": "0.493848",
        "create_time": 1651121580,
        "update_time": 1651121580
      }
    ]
  }
}

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码
limit 是 15 每页条数
filter 否 {"crontab_id":"1"} 检索字段值
op 否 {"crontab_id":"="} 检索字段操作

添加

基本信息

Path： /crontab/add

Method： POST

接口描述：

{
    "code": 200,
    "data": true,
    "msg": "信息调用成功！"
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 输出 thinkphp 版本 任务标题
type text 是 1 任务类型 (1 command, 2 class, 3 url,4 shell)
rule text 是 */3 * * * * * 任务执行表达式
target text 是 version 调用任务字符串
parameter text 否 调用任务参数(url和shell无效)
remark text 是 每3秒执行 备注
sort text 是 0 排序
status text 是 1 状态[0禁用; 1启用]
singleton text 否 1 是否单次执行 [0 是 1 不是]

重启

基本信息

Path： /crontab/reload

Method： POST

接口描述：

{
  "code": 200,
  "msg": "信息调用成功",
  "data": {
  }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1,2 计划任务ID 多个逗号隔开

返回数据

{
  "code": 200,
  "msg": "信息调用成功",
  "data": {
  }
}