Restful API示例文档

接口规范

Sign签名规则

1. sign = md5(apiKey . 时间戳 . 请求uri . apiSecret)

示例代码

1
2
3
4
5
6


$apiKey = "11";
$apiSecret = "11";
$time = time();
$uri = "/v1/user/add";

$sign = md5($apiKey.$time.$uri.$apiSecret);

请求url格式

host/uri?time=1629164652&sign=c5571d256785bcad088b181d42ccf4b3

示例： /v1/user/add?time=1629164652&sign=c5571d256785bcad088b181d42ccf4b3

响应数据说明

字段	类型	说明
code	int	响应code，0表示成功
message	string	消息
data	mixed	获取结果返回数据

接口列表

查询任务列表（GET）

/v1/task/list

查询条件

字段	说明
id	任务ID
protocol	协议
name	任务名称
tag	标签
host_id	任务节点
modules_id	模块id
page	页数
page_size	每页显示数量

查询任务详情(GET)

/v1/task/detail/{任务ID}

新增&修改任务（POST）

/v1/task/store

请求字段说明

字段	类型	是否必填	说明
id	int	否	新增默认为0，修改id不能为0
name	string	否	任务名称
tag	string	否	标签
level	int	是	任务类型： 1主任务，2子任务
dependency_status	int	是	依赖关系： 1强依赖，2弱依赖
dependency_task_id	string	否	依赖子任务ID
business_level	int	否	业务重要等级： 1低，2中，3高
protocol	int	是	协议： 1http 2shell
http_method	int	是	http请求方式： 1get 2post
command	string	是	命令
host_id	string	是	任务节点
spec	string	是	crontab表达式
modules_id	int	是	模块ID
timeout	int	否	任务超时时间（秒），默认0
multi	int	是	是否单实例运行：2是，1否
multi_quantity	int	否	多实例进程个数，最大10个，单实例默认为0
execute_time	int	否	任务运行时长告警（秒），默认0，最大86400
retry_times	int	否	任务失败重试次数，默认0
retry_interval	int	否	任务失败重试间隔时间，默认0
notify_status	int	是	任务通知，1通知，2失败通知，3总是通知
notify_type	int	是	通知类型：默认填4钉钉通知
remark	string	否	备注

禁用任务（POST）

/v1/task/disable/{任务ID}

启动任务（POST）

/v1/task/enable/{任务ID}

异步任务（POST）

/v1/task/remove/{任务ID}

查询任务执行日志（GET）

/v1/task/log

请求字段说明

字段	类型	说明
task_id	int	任务ID
protocol	int	协议
status	int	状态
start_time	int	开始时间
end_time	int	结束时间
page	int	页数
page_size	int	每页显示数量

响应数据说明

字段	类型	说明
hostname	string	主机节点
retry_times	int	重试次数
start_time	datetime	执行开始时间
end_time	datetime	执行结束时间
status	int	状态： 0执行失败，1执行中，2执行完成
result	string	执行结果
total_time	int	耗时（秒）

接口规范#

Sign签名规则#

请求url格式#

响应数据说明#

接口列表#

查询任务列表（GET）#

查询任务详情(GET)#

新增&修改任务（POST）#

禁用任务（POST）#

启动任务（POST）#

异步任务（POST）#

查询任务执行日志（GET）#