Home

Jump to bottom

caojingwei edited this page May 19, 2017 · 51 revisions

swordfish 的目标是提供一个分布式的调度框架，能够支持各种任务类型的调度，用户可以通过 Restful API 与系统进行交互，完成任务的调度工作。

Restful API 说明

补充说明

在需要写入 sessionId 的地方，通过头部来写入：sessionId: the-session-id，也可以通过 Cookie 来写入：Cookie: xxx; sessionId=the-session-id, 优先级为：头部中 sessionId > Cookie 中 sessionId
API 是具有版本的，客户端访问需要在 Accept 中加入版本号，比如：Accept: xxx; version=1.0
返回日期字段的格式为13位的毫秒时间戳，如：1490087250094
任务运行的代理用户不能为 root 等用户，具体可以参见配置 common/base_config.properties 中的 prohibit.user.list

关于枚举字段的一些说明

枚举都用大写，比如 NO_DEP_PRE, DEP_PRE 等，在涉及状态的时候用整数而非字符串

一些基本字段的定义

字段名称	定义	长度限制(字节)
项目名称	由字母开头, 支持 "下划线/数字/字母"	[2,64]
用户名称	由字母开头, 支持 "下划线/数字/字母"	[6,20]
邮箱名称	是一个合法的邮箱，规则 "[\w\.-]+@[\w-]+(\.[\w-]+)+"	[2,64]
资源名称	由字母开头，支持 "字母/下划线/中划线/点/数字"	[2,64]
数据源名称	由字母开头, 支持 "下划线/数字/字母"	[2,64]
工作流名称	由字母开头, 支持 "下划线/数字/字母"	[2,64]

API返回码的定义

返回码	定义	备注
200		一般接口处理正常返回
201		创建成功返回码
304		无法进行修改返回码
400		请求体异常返回码
401		授权异常返回码
404		找不到资源常返回码
500		服务器内部异常返回码

附录