mogic / t3x-scheduler-status
监控调度任务执行状态的API
v0.3.0
2024-05-06 06:58 UTC
Requires
- typo3/cms-core: ^11.5 || ^12.4
- typo3/cms-scheduler: ^11.5 || ^12.4
README
此TYPO3扩展提供了一个简单的JSON API路由,该路由返回 调度 状态
- 概述状态字段,如果一切正常
- 失败、迟到、禁用和正在运行的任务数量
- 关于每个任务的详细信息
设置
安装此扩展
$ composer require mogic/t3x-scheduler-status
将TypoScript模板 "调度状态" 包含到您的根TypoScript模板中
在TypoScript常量中配置API密钥
在您的
config/sites/*/config.yaml
中包含路由配置imports: - { resource: 'EXT:scheduler_status/Configuration/Routes/Default.yaml' }
获取调度状态
http://typo3.example.org/scheduler-status.json?token=mysecret
TYPO3
支持TYPO3 v11和v12,使用v0.3。
支持TYPO3 v10,直到v0.2。
API响应
示例响应
{ "status": "ok", "errored": 0, "late": 0, "running": 0, "longrunning": 0, "disabled": 0, "tasks": [ { "id": 2, "name": "IP-Adressen in Datenbanktabellen anonymisieren", "description": "", "disabled": false, "group": "admin", "groupid": 1, "late": false, "running": false, "last": null, "lasterror": null, "lastsuccess": false, "next": "2023-04-29T08:31:22+02:00", "next_seconds": 600 } ] }
字段说明
状态
可能的值
error
当任务在最后一次运行中发生错误时late
当任务未按计划启动时ok
当一切正常时
正在运行
- 当前正在运行的任务数量。
长时间运行
- 仍处于运行状态且应该已经重新启动的任务数量。
next_seconds
- 任务将在多少秒后运行。如果应该已经启动但无法启动因为仍在运行,则为负数。