用户管理

服务器API

服务器端API是由Open-Job后端提供的一系列HTTP(s)接口，用于业务系统和管理后台对接。比如管理员登录、创建任务、执行任务等。

登录相关

获取验证码

简要描述

根据参数不同可支持获取图片验证码，短信验证码，

请求 URL

http://x.x.x.x:8080/validate/code/

请求方式

POST

请求示例

{
  "type": "image",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名	类型	必选	说明
type	string	是	验证码类型，可选值：sms，image，scan
mobile	string	否	当 type 为 sms 的时候需要传入该字段
deviceId	string	是	客户端会话唯一标识

返回示例

图片二进制流或短信验证码

返回参数

图片二进制流或短信验证码

账号密码登录获取 Token

简要描述

用户使用账号密码登录管理系统并获取 token，使用 token 便可以拿到用户信息

请求 URL

http://x.x.x.x:8080/login/account

请求方式

POST

请求示例

{
  "username": "admin",
  "password": "123456",
  "captcha": "5694",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名	类型	必选	说明
username	string	是	用户的登录账号
password	string	是	用户的登录密码
captcha	string	是	图片验证码
deviceId	string	是	客户端会话唯一标识

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "accessToken": "baoj1xit1ajymp0jzyoz0nkm08778so8",
    "expiredTime": "1647767386251"
  },
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
accessToken	string	token
expiredTime	string	token过期时间戳（秒）
success	boolean	是否成功

手机号短信验证码登录获取 Token

简要描述

用户使用手机号短信验证码登录管理系统并获取 token，使用 token 便可以拿到用户信息

请求 URL

http://x.x.x.x:8080/login/mobile

请求方式

POST

请求示例

{
  "mobile": "12345678901",
  "captcha": "5694",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名	类型	必选	说明
mobile	string	是	手机号
captcha	string	是	短信验证码
deviceId	string	是	客户端会话唯一标识

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "accessToken": "baoj1xit1ajymp0jzyoz0nkm08778so8",
    "expiredTime": "1647767386251"
  },
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
accessToken	string	token
expiredTime	string	token过期时间戳（秒）
success	boolean	是否成功

用 Token 换取用户信息

简要描述

使用 token 换取用户信息

请求 URL

http://x.x.x.x:8080/openJobUser/currentUser

请求方式

请求示例

请求头需要添加 Authorization，值就是 Bearer + 空格 + token

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxx

请求参数

请求头需要添加 Authorization，值就是 Bearer + 空格 + token

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "id": "1",
    "username": "lijunping",
    "password": "$2a$10$3oNlO/vvXV3FPsmimv0x3ePTcwpe/E1xl86TDC0iLKwukWkJoRIyK",
    "phone": "12345678901",
    "status": 1,
    "createTime": "2021-06-24 15:53:16",
    "updateTime": "2021-06-24 15:53:19"
  },
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
id	int	用户唯一标识
username	string	用户名
password	string	密码
phone	string	用户名
status	int	用户状态 1 未锁定，0 锁定
createTime	date	创建时间
updateTime	date	更新时间
success	boolean	是否成功

任务相关

获取任务列表

简要描述

获取任务列表，支持通过任务名称，Handler名称，任务状态，任务创建时间进行筛选

请求 URL

http://x.x.x.x:8080/openJob/page

请求方式

请求示例

{
  "current": 1,
  "pageSize": 20
}

请求参数

参数名	类型	必选	说明
jobName	string	否	任务名称
handlerName	string	否	handler 名称
status	int	否	任务状态，1 启动，0 停止
beginTime	date	否	开始时间，根据任务创建时间进行筛选
endTime	date	否	结束时间，根据任务创建时间进行筛选
current	int	否	当前页，不传默认为 1
pageSize	int	否	每页条数，不传默认为 10

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "records": [
      {
        "id": "1",
        "jobName": "测试任务",
        "handlerName": "job-one",
        "cronExpression": "0/5 * * * * ? *",
        "params": null,
        "status": 0,
        "createTime": "2021-09-29 16:51:32",
        "updateTime": "2021-09-29 16:51:35",
        "createUser": "1",
        "updateUser": "1"
      }
    ],
    "total": "1",
    "current": "1",
    "pages": "1",
    "hasPrevious": false,
    "hasNext": false
  },
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
id	int	任务唯一标识
jobName	string	任务名称
handlerName	string	任务 Handler 名称
cronExpression	string	cron 表达式
params	string	任务参数，json 格式
status	int	任务状态，1 运行中，0 停止中
createTime	date	创建时间
updateTime	date	更新时间
createUser	int	创建人
updateUser	int	更新人
total	int	总共有多少条记录
current	int	当前第多少页
pages	int	共多少页
hasPrevious	boolean	是否有上一页
hasNext	boolean	是否有下一页
success	boolean	是否成功

创建新任务

简要描述

创建新任务

请求 URL

http://x.x.x.x:8080/openJob/save

请求方式

POST

请求示例

{
  "jobName": "测试任务",
  "handlerName": "handler-one",
  "cronExpression": "0 0 0/5 * * ? *",
  "params": ""
}

请求参数

参数名	类型	必选	说明
jobName	string	是	任务名称
handlerName	string	是	handler 名称
cronExpression	string	是	cron 表达式
params	string	否	任务执行参数

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": true,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
data	boolean	操作是否成功
success	boolean	是否成功

修改任务

简要描述

更新任务的某些值

请求 URL

http://x.x.x.x:8080/openJob/update

请求方式

请求示例

{
  "jobName": "测试任务",
  "handlerName": "handler-one",
  "cronExpression": "0 0 0/5 * * ? *",
  "params": ""
}

请求参数

参数名	类型	必选	说明
jobName	string	是	任务名称
handlerName	string	是	handler 名称
cronExpression	string	是	cron 表达式
params	string	否	任务执行参数

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": true,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
data	boolean	操作是否成功
success	boolean	是否成功

启动定时任务

简要描述

启动定时任务

请求 URL

http://x.x.x.x:8080/openJob/start/{id}

请求方式

请求示例

{
  "id": 1
}

请求参数

参数名	类型	必选	说明
id	int	是	任务 id

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": true,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
data	boolean	操作是否成功
success	boolean	是否成功

停止定时任务

简要描述

停止定时任务

请求 URL

http://x.x.x.x:8080/openJob/stop/{id}

请求方式

请求示例

{
  "id": 1
}

请求参数

参数名	类型	必选	说明
id	int	是	任务 id

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": true,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
data	boolean	操作是否成功
success	boolean	是否成功

执行任务

简要描述

执行任务一次

请求 URL

http://x.x.x.x:8080/openJob/run/{id}

请求方式

请求示例

{
  "id": 1
}

请求参数

参数名	类型	必选	说明
id	int	是	任务 id

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": true,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
data	boolean	操作是否成功
success	boolean	是否成功

获取Cron表达式下次执行时间

简要描述

获取Cron表达式下次执行时间

请求 URL

http://x.x.x.x:8080/openJob/nextTriggerTime

请求方式

请求示例

{
  "cronExpress": "0 0 0/5 * * ? *"
}

请求参数

参数名	类型	必选	说明
cronExpress	string	是	cron 表达式

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": true,
  "success": true
}

返回参数

参数名	类型	说明
code	int	200成功，非200失败
msg	string	错误信息
data	boolean	操作是否成功
success	boolean	是否成功

Previous报警管理