添加:ZHub 管理接口文档和客户端使用指南
This commit is contained in:
51
docs/admin-apis/timer-reload-api.md
Normal file
51
docs/admin-apis/timer-reload-api.md
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: 重新加载定时调度配置接口
|
||||
description: ZHub 定时调度配置重新加载接口
|
||||
---
|
||||
|
||||
# 重新加载定时调度配置接口
|
||||
|
||||
## 接口说明
|
||||
|
||||
- **路径**: `GET /timer/reload`
|
||||
- **功能**: 重新加载数据库中的定时调度配置
|
||||
- **用途**: 当修改了数据库中的 timer 配置后,无需重启服务即可生效
|
||||
|
||||
## 使用示例
|
||||
|
||||
```bash
|
||||
# 重新加载定时调度配置
|
||||
curl http://127.0.0.1:711/timer/reload
|
||||
```
|
||||
|
||||
## 使用场景
|
||||
|
||||
- 修改了 `tasktimer` 表中的定时任务配置
|
||||
- 添加或删除了定时任务
|
||||
- 修改了定时任务的执行表达式
|
||||
- 更新了定时任务的执行参数
|
||||
|
||||
## 操作步骤
|
||||
|
||||
1. **修改配置**: 在数据库中修改 `zhub.tasktimer` 表
|
||||
2. **执行重载**: 调用 `/timer/reload` 接口
|
||||
3. **验证生效**: 新的定时配置立即生效
|
||||
|
||||
## 数据库配置
|
||||
|
||||
### tasktimer 表结构
|
||||
|
||||
定时任务配置存储在 `zhub.tasktimer` 表中,包含以下关键字段:
|
||||
|
||||
- `task_name`: 任务名称
|
||||
- `cron_expression`: Cron 表达式
|
||||
- `task_class`: 任务执行类
|
||||
- `enabled`: 是否启用
|
||||
- `parameters`: 任务参数
|
||||
|
||||
## 注意事项
|
||||
|
||||
:::info 重要提醒
|
||||
- 重载操作会立即生效,请确保配置正确
|
||||
:::
|
||||
Reference in New Issue
Block a user