组件介绍
定时任务
本服务在传统单机定时任务的基础上实现了分布式任务同步、多服务器之间的任务失效转移、定时发送HTTP任务。以后支持定时发送MQ消息,还可能根据需求扩展定时任务类型。
API 参考
API 列表(共2个)
序号 | 接口名称 | 接口描述 | 版本 |
1 | 新增任务 | POST: /scheduler/job/add | V1.00 |
2 | 删除任务 | POST: /scheduler/job/remove | V1.00 |
新增任务
基本信息
Path:/scheduler/job/add
Method: POST
接口描述:
常用cron表达式:
每隔5秒执行一次:*/5 * * * * ?
每隔1分钟执行一次:0 */1 * * * ?
每天23点执行一次:0 0 23 * * ?
每天凌晨1点执行一次:0 0 1 * * ?
每月1号凌晨1点执行一次:0 0 1 1 * ?
每月最后一天23点执行一次:0 0 23 L * ?
每周星期天凌晨1点实行一次:0 0 1 ? * L
在26分、29分、33分执行一次:0 26,29,33 * * * ?
每天的0点、13点、18点、21点都执行一次:0 0 0,13,18,21 * * ?
附上cron时间表达式在线生成工具:http://www.pppet.net/
请求参数
Headers
参数名 | 是否必须 | 类型 | 说明 |
Content-Type | 是 | string | 请求类型: application/json |
body
参数名 | 是否必须 | 类型 | 说明 |
jobName | 是 | string | 任务名称,不允许包含“#”号 |
cron | 是 | string | cron时间表达式,具体见备注 |
qzJobParam | 是 | Object | 参数说明见下表 |
一级参数 | 二级参数 | 是否必须 | 类型 | 说明 |
qzJobParam | httpOrMq | 否 | boolean | true表示请求方式为http,此字段为扩展支持mq请求所设 |
qzHttpParam | 否 | Object | http请求参数,说明见下表 | |
userKey | 否 | String | 1.0中是用户名,2.0中为用户id |
一级参数 | 二级参数 | 是否必须 | 类型 | 说明 |
qzHttpParam | body | 否 | string | 请求体,注:method为get或者post请求时,body不能为空 |
header | 否 | map<string,string> | 请求头 | |
method | 是 | string | 请求方法,支持get,post和put | |
url | 是 | string | 请求url |
删除任务
基本信息
Path:/scheduler/job/remove
Method: POST
接口描述:
请求参数
Headers
参数名 | 是否必须 | 类型 | 说明 |
Content-Type | 是 | string | 请求类型: application/json |
Body
参数名 | 是否必须 | 类型 | 说明 |
jobName | 是 | string | 任务名称 |
返回参数
产品版本
版本更新纪录
日期 | 修改描述 | 作者 |
2020-4-3 | 初版发布 | 平台产品部 |
更新日志
日期 | 修改描述 |
2019-6-18 | 发布定时任务,创建定时任务的用户使用手册 |