API

---

参数及加密方法

使用API前请在配置文件conf/app.ini中配置 api.key, api.secret
关闭签名验证, 在配置文件中添加 api.sign.enable = false

参数名	类型	含义	备注
time	int	Unix时间戳(秒)	例: 1495519926
sign	string	签名(小写)	例: 418819b148815894e4abfa944d19f70f

签名生成规则

1. 参数值拼接成字符串, (api.key + time + 请求url路径 + api.secret)
2. md5生成签名
   例

$apiKey = "absddd"
$time = "1495519926"
$urlPath = "/api/v1/tasklog/update-status"
$apiSecret = "lisixasdse" 
$sign = md5($apiKey . $time . $urlPath . $apiSecret)

返回值

格式 json
返回参数

参数名	类型	含义	备注
code	int	状态码	0: 成功 非0: 失败
message	string	状态描述信息
data	object, null	附加信息

接口定义

异步任务更新执行结果

URL地址 /api/v1/tasklog/update-status
请求方式 GET|POST
请求参数

参数名	类型	含义	备注
id	string	任务id	从环境变量GOCRON_TASK_ID中获取，
status	int	任务执行结果	2: 执行成功 1: 执行失败
result	string	任务输出内容

删除N个月前的定时任务日志, 可加入定时任务

URL地址 /api/v1/tasklog/remove/{month}
{month}表示N个月，取值1-12
请求方式 POST
例:

• 删除1个月前的日志 /api/v1/tasklog/remove/1
• 删除3个月前的日志 /api/v1/tasklog/remove/3

新增延时任务

URL地址 /api/v1/delaytask/push
请求方式 POST
请求参数

参数名	类型	含义	备注
delay	int	延迟时间,单位秒	取值范围1-(2^31-1)
url	string	回调URL地址	长度不能超过128
params	string	回调参数	长度不能超过256

回调

将以POST方式带上参数params访问url, 最长执行时间不能超过300秒
接收成功返回纯文本success, 返回值非success, 最多重试2次(每次间隔30秒)