Skip to content
qiang.ou edited this page May 27, 2018 · 18 revisions

参数及加密方法

使用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 附加信息

接口定义

v1.5版本开始前后端分离, 所有后台操作均支持API调用,文档待整理

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

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

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

开启定时任务 (v1.0版本开始支持)

URL地址 /api/v1/task/enable/{task_id}
{task_id}表示任务ID 请求方式 POST

关闭定时任务 (v1.0版本开始支持)

URL地址 /api/v1/task/disable/{task_id}
{task_id}表示任务ID 请求方式 POST