-
Notifications
You must be signed in to change notification settings - Fork 18
Home
qifeng dai edited this page Oct 11, 2017
·
51 revisions
swordfish 的目标是提供一个分布式的调度框架，能够支持各种任务类型的调度，用户可以通过 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 - 所有任务的最大超时时间(timeout 字段)为 86400
- 枚举都用大写，比如
NO_DEP_PRE,DEP_PRE等，在涉及状态的时候用整数而非字符串
| 字段名称 | 定义 | 长度限制(字节) |
|---|---|---|
| 项目名称 | 由字母开头, 支持 "下划线/数字/字母" | [2,64] |
| 用户名称 | 由字母开头, 支持 "下划线/数字/字母" | [6,20] |
| 邮箱名称 | 是一个合法的邮箱，规则 "[\w\.-]+@[\w-]+(\.[\w-]+)+" | [2,64] |
| 资源名称 | 由字母开头，支持 "字母/下划线/中划线/点/数字" | [2,64] |
| 数据源名称 | 由字母开头, 支持 "下划线/数字/字母" | [2,64] |
| 工作流名称 | 由字母开头, 支持 "下划线/数字/字母" | [2,64] |
| 流任务名称 | 由字母开头, 支持 "下划线/数字/字母" | [2,64] |
| 返回码 | 定义 | 备注 |
|---|---|---|
| 200 | 一般接口处理正常返回 | 非 POST 接口的正常返回码 |
| 201 | 创建成功返回码 | POST 接口的正常返回码 |
| 400 | 请求体异常返回码 | 当请求体中的参数不符合请求要求的时候返回状态码 |
| 401 | 授权异常返回码 | 当请求不被正确授权时返回的状态码 |
| 412 | 为满足前置条件返回码 | 当请求没有满足前置条件的时候返回的状态码 |
| 404 | 找不到资源常返回码 | 当找不到请求中的资源时返回的状态码 |
| 500 | 服务器内部异常返回码 | 当处理请求出现内部异常时返回的状态码 |