附录
更新时间：2024-08-16
附录
Template
| 名称 | 类型 | 描述 |
|---|---|---|
| description | String | 模板描述 |
| name | String | 模板名称，不允许重复 |
| operators | List<Operator> | 模板任务步骤列表 |
| properties | List<Property> | 全局参数列表 |
| linear | boolean | 任务是否串行执行，必填 |
| links | List<Link> | 描述operator之间的拓扑关系，若linear=false，则该字段必填 |
Operator
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 任务自定义名称，同一个模板下不允许重复 |
| description | String | 任务描述，选填 |
| operator | String | 任务ID，参考模板任务列表接口返回内容 |
| label | String | 任务显示名称 |
| parallelismRatio | double | 允许的并行比例，选填，默认值：0，表示串行执行。取值范围[0, 1]，该字段仅当loops字段存在时生效 |
| parallelismCount | int | 允许的并行个数，选填，默认值：0，表示串行执行，只允许对parallelismRatio和parallelismCount之一进行设置 |
| allowedFailureRatio | double | 允许失败的loops比例，选填，默认值：0，表示不允许失败。取值范围[0, 1]，该字段仅当loops字段存在时生效，表示在循环中允许失败的比例 |
| allowedFailureCount | int | 允许失败的loops个数，选填，默认值：0，表示不允许失败 |
| retries | int | 重试次数，选填，默认值：0，表示不重试 |
| retryInterval | int | 重试间隔，单位：毫秒，选填，默认值：5分钟 |
| timeout | int | 超时时长，单位：毫秒，选填，默认值：6小时，如果任务执行时长超过该限制，将会触发重试 |
| scheduleDelayMilli | int | 延时启动，单位毫秒，默认值0 |
| manually | boolean | 是否需要手动执行，默认值false |
| pauseOnFailure | boolean | 失败后是否暂停，默认值false |
| category | List |
任务所属的类别 |
| properties | Map<String, Object> | 任务执行所需参数列表 |
| events | List<Event> | 任务关联产生的审计事件列表 |
Property
| 名称 | 类型 | 描述 |
|---|---|---|
| type | String | 参数类型 |
| name | String | 参数名称 |
| required | boolean | 是否必填 |
| description | String | 参数描述 |
| defaultValue | Object | 默认取值 |
| value | Object | 实际取值 |
Execution
| 名称 | 类型 | 描述 |
|---|---|---|
| id | String | 执行ID，全局唯一 |
| template | Template | 运维模板内容 |
| createdTimestamp | long | 执行开始时间，Unix时间戳，单位：毫秒 |
| updatedTimestamp | long | 执行更新时间，Unix时间戳，单位：毫秒 |
| finishedTimestamp | long | 执行结束时间，Unix时间戳，单位：毫秒，若未结束，该字段填0 |
| state | String | 执行状态，可取值为： PENDING（等待中） RUNNING（运行中） SUCCESS（运行成功） FAILED（运行失败） PAUSED（暂停） CANCELED（已取消） ROLLBACK（回滚中） ROLLBACK_SUCCESS（回滚成功） ROLLBACK_FAILED（回滚失败） |
| properties | Map<String, Object> | 全局参数取值集合 |
| description | String | 执行描述 |
| tasks | List<Task> | 执行中的任务列表 |
| tags | List<Tag> | 执行绑定标签列表 |
Task
| 名称 | 类型 | 描述 |
|---|---|---|
| id | String | 任务ID，全局唯一 |
| dag | Execution | 任务所属的执行 |
| createdTimestamp | long | 任务开始时间，Unix时间戳，单位：毫秒 |
| updatedTimestamp | long | 任务更新时间，Unix时间戳，单位：毫秒 |
| finishedTimestamp | long | 任务结束时间，Unix时间戳，单位：毫秒，若未结束，该字段填0 |
| state | String | 任务状态，可取值为： PENDING（等待中） RUNNING（运行中） SUCCESS（运行成功） FAILED（运行失败） UP_FOR_RETRY（等待重试中） UPSTREAM_FAILED（由于上游失败而导致的当前节点失败） SKIPPED（被跳过而未执行） IGNORED（错误被忽略） |
| operator | Operator | 任务详细信息 |
| initContext | Map<String, Object> | 任务初始参数 |
| context | Map<String, Object> | 任务上下文信息，包含全局参数和输出结果 |
| outputContext | Map<String, Object> | 任务输出结果 |
| tries | int | 任务尝试次数，从0开始 |
| children | List<Task> | 子任务列表 |
Link
| 名称 | 类型 | 描述 |
|---|---|---|
| src | String | 上游operator的name |
| dst | String | 下游operator的name |
Tag
| 名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签key |
| tagValue | String | 标签value |