更新

POST

{{URL}}/cron/v1/update

Cron 定时任务

请求参数

Authorization

在 header 添加参数

api-token

示例：

api-token: ********************

Body 参数application/json

number

唯一标识

必需

name

string

任务名称

可选

cron

string

定时表达式

可选

shell

string

执行的命令

可选

active

number

可选

状态 1启用 | 0禁用

remark

string

任务备注

可选

config

string

高级配置

可选

示例值:

{"before_task_shell": "任务运行前的执行命令", "after_task_shell": "任务运行后的执行命令", "log_directory": "日志目录路径（纯前端功能关联数据）", "source_file": "源码文件路径（纯前端功能关联数据）", "allow_concurrency": "是否允许并发"}

示例

{
    "id": 0,
    "name": "string",
    "cron": "string",
    "shell": "string",
    "active": 0,
    "remark": "string",
    "config": "{\"before_task_shell\": \"任务运行前的执行命令\", \"after_task_shell\": \"任务运行后的执行命令\", \"log_directory\": \"日志目录路径（纯前端功能关联数据）\", \"source_file\": \"源码文件路径（纯前端功能关联数据）\", \"allow_concurrency\": \"是否允许并发\"}"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://localhost:5678/api/open/cron/v1/update' \
--header 'Content-Type: application/json' \
--header 'api-token;' \
--data-raw '{
    "id": 0,
    "name": "string",
    "cron": "string",
    "shell": "string",
    "active": 0,
    "remark": "string",
    "config": "{\"before_task_shell\": \"任务运行前的执行命令\", \"after_task_shell\": \"任务运行后的执行命令\", \"log_directory\": \"日志目录路径（纯前端功能关联数据）\", \"source_file\": \"源码文件路径（纯前端功能关联数据）\", \"allow_concurrency\": \"是否允许并发\"}"
}'

返回响应

🟢200成功

application/json

响应

Body

number

唯一标识

可选

name

string

任务名称

可选

type

enum<string>

可选

任务类型，当前固定分为 user 和 system

枚举值:

usersystem

cron

string

可选

定时规则（5位或6位的定时表达式）

shell

string

执行的命令

可选

active

enum<number>

可选

状态 1 启用 | 0 禁用

枚举值:

config

string

高级配置

可选

tags

string

任务标签

可选

last_runtime

string

最后一次运行的时间

可选

last_run_use

number

可选

最后一次运行的时长（单位秒，精确到小数点后3位）

sort

number

可选

在分页中的位置序号（正整数），默认按照先后顺序递增

create_time

string

任务创建时间

可选

remark

string

备注

可选

bind

string

可选

后端用于关联底层内容的参数（仅系统任务使用）

is_running

boolean

可选

当前运行状态（任务是否正在运行）

示例

{
    "id": 0,
    "name": "string",
    "type": "user",
    "cron": "string",
    "shell": "string",
    "active": 0,
    "config": "string",
    "tags": "string",
    "last_runtime": "string",
    "last_run_use": 0,
    "sort": 0,
    "create_time": "string",
    "remark": "string",
    "bind": "string",
    "is_running": true
}

创建

删除