跳至主要内容

计时服务管理

获取计时配置 - /api/cron-config

  • 端点: /api/cron-config

  • 方法: GET

  • 描述: 检索当前的计时服务配置。

  • 身份验证: 需要有效的会话和 CSRF 令牌

  • 响应:

    {
    "cronExpression": "*/20 * * * *",
    "enabled": true
    }
  • 错误响应:

    • 500: 获取计时配置失败
  • 备注:

    • 返回当前的计时服务配置
    • 包括计时表达式和启用状态
    • 用于计时服务管理

更新计时配置 - /api/cron-config

  • 端点: /api/cron-config

  • 方法: POST

  • 描述: 更新计时服务配置。

  • 身份验证: 需要有效的会话和 CSRF 令牌

  • 请求体:

    {
    "interval": "20min"
    }
  • 响应:

    {
    "success": true
    }
  • 可用间隔: "disabled", "1min", "5min", "10min", "15min", "20min", "30min", "1hour", "2hours"

  • 错误响应:

    • 400: 间隔是必需的
    • 500: 更新计时配置失败
  • 备注:

    • 更新计时服务配置
    • 验证间隔对允许的选项
    • 影响逾期备份检查频率

计时服务代理 - /api/cron/*

  • 端点: /api/cron/*

  • 方法: GET, POST

  • 描述: 代理请求到计时服务。该端点将所有请求转发到在单独端口上运行的计时服务。

  • 身份验证: 需要有效的会话和 CSRF 令牌

  • 参数:

    • *: 将被转发到计时服务的任何路径
  • 响应: 取决于被访问的计时服务端点

  • 错误响应 (503):

    {
    "error": "Cron service is not running",
    "message": "The cron service is not available. Please start it with: npm run cron:start"
    }
  • 备注:

    • 代理请求到计时服务
    • 如果计时服务不可用,则返回 503
    • 支持 GET 和 POST 方法
    • 从 Web 界面用于计时服务管理