附录
更新时间:2026-07-17
Model对象定义
AllowedFailureControl
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ratio | Double | 允许失败比例,取值 [0,1] |
| count | int | 允许失败个数;ratio 与 count 不能同时设置 |
Category
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 分类名 |
| sequence | int | 排序序号 |
CronExecution
| 参数名称 | 类型 | 描述 |
|---|---|---|
| namespace | String | 名称空间 |
| description | String | 描述 |
| name | String | 定时运维名称 |
| template | Template | |
| templateDeleted | Boolean | 模板是否已被删除 |
| properties | Map<String, String> | 全局参数取值集合 |
| tags | List<Tag> | 标签 |
| cron | String | cron 表达式 |
| period | Period | 周期配置 |
| dependOnPast | Boolean | 是否依赖上次执行 |
| scheduleTimeout | int | 调度超时(毫秒) |
| createdTimestamp | long | 创建时间,Unix 时间戳,单位:毫秒 |
| updatedTimestamp | long | 更新时间,Unix 时间戳,单位:毫秒 |
| nextScheduleTimestamp | long | 下一次调度时间,Unix 时间戳,单位:毫秒 |
| beginTimestamp | long | 生效开始时间,Unix 时间戳,单位:毫秒 |
| endTimestamp | long | 生效结束时间,Unix 时间戳,单位:毫秒 |
| state | String | 状态 |
| locale | String | 语言 |
DagActionModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pause | Boolean | 是否暂停 |
| resume | Boolean | 是否恢复 |
DagInstance
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | DAG(执行)ID,全局唯一 |
| description | String | 执行描述 |
| revision | long | 版本号,更新 DAG 时需要携带 |
| createdTimestamp | long | 执行创建时间,Unix 时间戳,单位:毫秒 |
| updatedTimestamp | long | 执行最近更新时间,Unix 时间戳,单位:毫秒 |
| finishedTimestamp | long | 执行结束时间,Unix 时间戳,单位:毫秒;未结束时填 0 |
| namespace | String | 名称空间,DAG 仅在所属 namespace 下执行 |
| state | String | 执行状态:PENDING(等待中)、RUNNING(运行中)、SUCCESS(运行成功)、FAILED(运行失败)、PAUSED(暂停)、CANCELED(已取消)、ROLLBACK(回滚中)、ROLLBACK_SUCCESS(回滚成功)、ROLLBACK_FAILED(回滚失败) |
| dagSpec | DagSpec | 子模板规格 |
| initContext | Map<String, String> | 全局参数取值集合(Map<String,Object>) |
| parallelism | int | 并发度 |
| manually | Boolean | 是否手动触发,默认 false |
| workerSelectors | List<TagSelector> | 工作机选择器列表(List |
| tasks | List<ExecutionTaskSummary> | 执行中的任务列表(List |
| user | Map<String, String> | 执行所属用户信息 |
| operatorActions | Map<String, Object> | operator 级别动作映射,key 为 operator 名称,value 为对应动作(Map<String,OperatorActionModel>) |
| dagActions | DagActionModel | 执行级别动作(pause/resume 等) |
| event | EventModel | |
| parentTask | ExecutionTaskSummary | |
| trigger | String | 触发方式(如 manual / cron / event 等) |
| initOperators | List<TaskOperatorSummary> | 初始 operator 列表(List |
| reason | String | 状态原因(失败/取消等场景下的原因说明) |
| errorCode | String | 错误码 |
| cronDagName | String | 定时运维名称(cron 触发时填充) |
| eventDagName | String | 报警事件运维名称(event 触发时填充) |
DagSpec
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ref | String | 引用的模板 ref 标识 |
| namespace | String | 名称空间 |
| name | String | 模板名称 |
| names | List<String> | 模板名称列表(批量查询时使用) |
| description | String | 模板描述 |
| tags | Map<String, String> | 标签键值对 |
| operators | List<TaskOperatorSummary> | operator 列表 |
| linear | Boolean | 是否线性执行(operator 顺序依次执行) |
| links | List<LinkModel> | operator 间依赖关系列表 |
| inputs | List<InputModel> | 输入参数定义列表 |
| outputs | List<OutputModel> | 输出参数定义列表 |
| parallelism | int | 并发度 |
| extra | Map<String, String> | 扩展字段 |
| createdTimestamp | long | 创建时间,Unix 时间戳,单位:毫秒 |
| updatedTimestamp | long | 最近更新时间,Unix 时间戳,单位:毫秒 |
Event
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 事件名称 |
| description | String | 事件描述 |
| service | String | 事件来源服务 |
| region | String | 事件所属地域 |
| resource | Resource | 事件关联资源 |
EventExecution
| 参数名称 | 类型 | 描述 |
|---|---|---|
| namespace | String | 名称空间 |
| name | String | 事件运维名称 |
| state | String | 状态:RUNNING/STOPPED |
| description | String | 描述 |
| template | Template | |
| properties | Map<String, String> | 全局参数取值集合 |
| event | Event | 事件信息 |
| silentCycleMilli | int | 静默周期,单位毫秒 |
| tags | List<Tag> | 标签 |
| templateDeleted | Boolean | 模板是否已被删除 |
| locale | String | 语言 |
EventModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| properties | Map<String, String> | 事件属性键值对 |
Execution
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| id | String | 否 | 执行 ID,全局唯一,由服务端自动生成 |
| description | String | 否 | 执行描述 |
| template | Template | 是 | |
| templateDeleted | Boolean | 否 | 模板是否已被删除 |
| parallelism | int | 否 | 并发度 |
| manually | Boolean | 否 | 是否手动触发 |
| createdTimestamp | long | 否 | 执行开始时间,Unix 时间戳,单位:毫秒;仅用于查询详情或列表接口的字段返回 |
| updatedTimestamp | long | 否 | 执行更新时间,Unix 时间戳,单位:毫秒;仅用于查询详情或列表接口的字段返回 |
| finishedTimestamp | long | 否 | 执行结束时间,Unix 时间戳,单位:毫秒,未结束填 0;仅用于查询详情或列表接口的字段返回 |
| state | String | 否 | 执行状态:PENDING/RUNNING/SUCCESS/FAILED/PAUSED/CANCELED;仅用于查询详情或列表接口的字段返回 |
| properties | Map<String, String> | 否 | 全局参数取值集合 |
| tasks | List<ExecutionTaskSummary> | 否 | 执行中的任务列表;执行列表接口响应固定为空数组,仅用于查询详情接口的字段返回 |
| tags | List<Tag> | 否 | 执行绑定标签列表 |
| trigger | String | 否 | 触发执行的方式 |
| reason | String | 否 | 原因(失败/取消等) |
| errorCode | String | 否 | 错误码 |
| eventExecution | EventExecution | 否 | 报警事件运维信息 |
| cronExecution | CronExecution | 否 | 定时运维信息 |
| locale | String | 否 | 语言 |
ExecutionPage
| 参数名称 | 类型 | 描述 |
|---|---|---|
| executions | List<Execution> | 执行列表 |
| orderBy | String | 排序字段 |
| order | String | 排序方向 asc/desc |
| pageNo | int | 页数 |
| pageSize | int | 每页展示数量 |
| totalCount | int | 总数量 |
ExecutionTaskSummary
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 任务 ID |
| loopIndex | int | loops 序号 |
| namespace | String | 名称空间 |
| dag | DagInstance | 任务所属的 dag |
| revision | long | 版本号 |
| createdTimestamp | long | 任务开始时间,Unix 时间戳,单位:毫秒 |
| updatedTimestamp | long | 任务更新时间,Unix 时间戳,单位:毫秒 |
| finishedTimestamp | long | 任务结束时间,Unix 时间戳,单位:毫秒,未结束填 0 |
| state | String | 任务状态 |
| operator | TaskOperatorSummary | 任务详细信息 |
| reason | String | 原因 |
| errorCode | String | 错误码 |
| initContext | Map<String, String> | 任务初始参数 |
| context | Map<String, String> | 任务上下文,包含全局参数和输出结果 |
| outputContext | Map<String, String> | 任务输出结果 |
| tries | int | 任务尝试次数,从 0 开始 |
| children | List<ExecutionTaskSummary> | 子任务列表 |
| log | List<Log> | 任务日志列表 |
InputModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 参数名称 |
| required | Boolean | 是否必填 |
| type | String | 参数类型 |
| description | String | 参数描述 |
| options | List<Object> | 可选值列表 |
| default | Map<String, String> | 默认值 |
KeyValuePair
| 参数名称 | 类型 | 描述 |
|---|---|---|
| key | String | 键 |
| value | Map<String, String> | 值 |
LinkModel
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| src | String | 是 | 上游 operator 的 name |
| dst | String | 是 | 下游 operator 的 name |
Log
| 参数名称 | 类型 | 描述 |
|---|---|---|
| timestamp | String | 时间戳,精确到毫秒,如:2022-01-18 13:30:00.000 |
| level | String | 日志等级 |
| msg | String | 日志内容 |
| tags | Map<String, String> | 日志标签键值对 |
LoopModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| initContext | Map<String, String> | 循环初始上下文 |
| workerSelectors | List<TagSelector> | 工作机选择器列表 |
Operator
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | String | 是 | 任务自定义名称,同一个模板下不允许重复(必填) |
| description | String | 否 | 任务描述,选填 |
| tags | List<KeyValuePair> | 否 | 任务标签列表 |
| operator | String | 否 | 任务 ID/类型标识(如 BCE::BCC::StopInstance);与 template.ref 不可同时为空 |
| label | String | 否 | 任务显示名称 |
| template | Template | 否 | |
| retries | int | 否 | 重试次数,默认 0,表示不重试 |
| retryInterval | int | 否 | 重试间隔,单位毫秒,默认 300000(5 分钟) |
| timeout | int | 否 | 超时时长,单位毫秒,默认 21600000(6 小时);超时将触发重试 |
| parallelismRatio | Double | 否 | 允许的并行比例,取值 [0,1],默认 0;仅当 loops 字段存在时生效 |
| parallelismCount | int | 否 | 允许的并行个数,默认 0;与 parallelismRatio 二选一 |
| parallelismControl | ParallelismControl | 否 | 并行控制配置(ratio/count),与 parallelismRatio/parallelismCount 等价的对象形式 |
| allowedFailureRatio | Double | 否 | 允许失败的 loops 比例,取值 [0,1],默认 0 |
| allowedFailureCount | int | 否 | 允许失败的 loops 个数,默认 0 |
| allowedFailureControl | AllowedFailureControl | 否 | 允许失败控制配置(ratio/count),与 allowedFailureRatio/allowedFailureCount 等价的对象形式 |
| manually | Boolean | 否 | 是否需要手动执行,默认 false |
| scheduleDelayMilli | int | 否 | 延时启动,单位毫秒,默认 0 |
| waitOnAgentMilli | int | 否 | 等待 Agent 上线毫秒数 |
| pauseOnFailure | Boolean | 否 | 失败后是否暂停,默认 false |
| condition | Map<String, String> | 否 | 条件表达式,节点是否执行的判断依据(结构由具体表达式决定) |
| breakpoints | List<Integer> | 否 | 断点列表 |
| triggerRule | String | 否 | 触发规则,默认 ALL_SUCCESS |
| loopWindowType | String | 否 | 循环窗口类型,默认 SLICING |
| properties | Map<String, String> | 否 | 任务执行所需参数取值 |
| loops | List<Object> | 否 | 循环执行参数列表,与 targetInstances 不能同时设置 |
OperatorFilter
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | String | 是 | 系统操作符名称过滤关键字 |
OperatorPage
| 参数名称 | 类型 | 描述 |
|---|---|---|
| operators | List<OperatorSpec> | operator 列表 |
| categories | List<Category> | operator 分类列表 |
| orderBy | String | 排序字段 |
| order | String | 排序方向 asc/desc |
| pageNo | int | 页数 |
| pageSize | int | 每页展示数量 |
| totalCount | int | 总数量 |
OperatorSpec
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | operator 名称 |
| description | String | operator 描述 |
| tags | List<KeyValuePair> | 标签列表 |
| operator | String | operator 类型 |
| label | String | 显示名称 |
| template | Template | |
| retries | int | 重试次数 |
| retryInterval | int | 重试间隔,单位毫秒,默认 300000 |
| timeout | int | 超时时长,单位毫秒 |
| parallelismRatio | Double | 并行比例 |
| parallelismCount | int | 并行个数 |
| allowedFailureRatio | Double | 允许失败比例 |
| allowedFailureCount | int | 允许失败个数 |
| manually | Boolean | 是否手动执行 |
| scheduleDelayMilli | int | 延时启动毫秒数 |
| waitOnAgentMilli | int | 等待Agent可用毫秒数 |
| autoRollback | Boolean | 是否自动回滚 |
| pauseOnFailure | Boolean | 失败后是否暂停 |
| properties | List<Property> | 参数定义列表 |
| output | List<Property> | 输出参数定义列表 |
| initContext | Map<String, String> | 初始上下文 |
| loops | List<LoopModel> | 循环配置列表 |
| parallel | Boolean | 是否并行 |
Option
| 参数名称 | 类型 | 描述 |
|---|---|---|
| label | String | 选项显示名称 |
| value | Map<String, String> | 选项值 |
OutputModel
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | String | 是 | 输出名称 |
| type | String | 是 | 输出类型 |
| description | String | 否 | 输出描述 |
ParallelismControl
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ratio | Double | 并行比例,取值 [0,1] |
| count | int | 并行个数;ratio 与 count 不能同时设置 |
Period
| 参数名称 | 类型 | 描述 |
|---|---|---|
| frequency | String | 频率 |
| daysOfWeek | List<Integer> | 周几 |
| dates | List<Integer> | 几号 |
| lastDateOfMonth | Boolean | 是否每月最后一天 |
| hour | int | 小时(0-23) |
| minute | int | 分钟(0-59) |
Property
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | String | 是 | 参数名称 |
| required | Boolean | 否 | 是否必填 |
| type | String | 否 | 参数类型,支持的类型:string、number、boolean、list、object、bccInstance、hpasInstance |
| label | String | 否 | 参数显示名称 |
| description | String | 否 | 参数描述 |
| multiple | Boolean | 否 | 可选项列表是否允许多选 |
| options | List<Object> | 否 | 可选项列表 |
| selectOptions | List<Option> | 否 | 新版可选项列表,目前仅系统操作符使用 |
| defaultValue | Map<String, String> | 否 | 默认取值 |
Resource
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | String | 资源类型 |
| id | Map<String, String> | 资源标识,结构由资源类型决定 |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签 key |
| tagValue | String | 标签 value |
TagExpression
| 参数名称 | 类型 | 描述 |
|---|---|---|
| key | String | 标签 key |
| op | String | 操作符 |
| value | String | 单值 |
| values | List<String> | 多值 |
TagSelector
| 参数名称 | 类型 | 描述 |
|---|---|---|
| expressions | List<TagExpression> | 标签匹配表达式列表 |
Task
| 参数名称 | 类型 | 描述 |
|---|---|---|
| namespace | String | 名称空间 |
| userId | String | 用户 ID |
| id | String | 任务 ID,全局唯一 |
| revision | long | 版本号 |
| loopIndex | int | 当前任务所对应的 loops 序号 |
| reason | String | 原因(失败/取消等) |
| errorCode | String | 错误码 |
| execution | Execution | |
| operator | Operator | |
| createdTimestamp | long | 任务开始时间,Unix 时间戳,单位:毫秒 |
| updatedTimestamp | long | 任务更新时间,Unix 时间戳,单位:毫秒 |
| finishedTimestamp | long | 任务结束时间,Unix 时间戳,单位:毫秒,未结束填 0 |
| state | String | 任务状态,可取值为: PENDING(等待中) RUNNING(运行中) SUCCESS(运行成功) FAILED(运行失败) UP_FOR_RETRY(等待重试中) UPSTREAM_FAILED(由于上游失败而导致的当前节点失败) SKIPPED(被跳过而未执行) IGNORED(错误被忽略) |
| properties | Map<String, String> | 任务参数 |
| tries | int | 任务尝试次数,从 0 开始 |
| children | List<Task> | 子任务列表 |
| executions | List<Execution> | 子执行实例列表(重试时会产生多个执行实例) |
| outputContext | Map<String, String> | 任务输出结果 |
TaskChildrenPage
| 参数名称 | 类型 | 描述 |
|---|---|---|
| children | List<Task> | 子执行分页列表 |
| total | int | 子执行总数量 |
| orderBy | String | 排序字段 |
| order | String | 排序方向 asc/desc |
| pageNo | int | 页数,从 1 开始计数 |
| pageSize | int | 每页展示数量 |
TaskOperatorSummary
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | operator 名称 |
| description | String | operator 描述 |
| tags | Map<String, String> | 标签键值对 |
| operator | String | operator 类型标识 |
| dagSpec | DagSpec | 子模板规格 |
| inline | Boolean | 是否内联子模板 |
| retries | int | 重试次数 |
| retryInterval | int | 重试间隔,单位毫秒 |
| timeout | int | 超时时长,单位毫秒 |
| initContext | Map<String, String> | 初始上下文 |
| loops | List<Object> | 循环配置列表 |
| parallelismRatio | Double | 允许的并行比例,取值 [0,1] |
| parallelismCount | int | 允许的并行个数 |
| allowedFailureRatio | Double | 允许失败的 loops 比例,取值 [0,1] |
| allowedFailureCount | int | 允许失败的 loops 个数 |
| manually | Boolean | 是否需要手动触发 |
| pauseOnFailure | Boolean | 失败后是否暂停 |
| scheduleDelayMilli | int | 延时启动,单位毫秒 |
| waitOnAgentMilli | int | 等待 agent 就绪的超时时长,单位毫秒 |
| condition | Map<String, String> | 执行条件表达式 |
| breakpoints | List<Integer> | 断点列表 |
| triggerRule | String | 触发规则,默认 ALL_SUCCESS |
| loopWindowType | String | loop 窗口类型,默认 SLICING |
| workerSelectors | List<TagSelector> | 工作机选择器列表 |
| collectChildrenContext | String | 子执行上下文收集策略 |
| rollbackOperator | TaskOperatorSummary | 任务详细信息 |
| events | List<EventModel> | 关联审计事件列表 |
| initOperators | List<TaskOperatorSummary> | 初始 operator 列表 |
| byBsmAgent | Boolean | 是否通过 BSM Agent 执行 |
Template
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| id | String | 否 | 模板唯一标识,由服务端生成,更新模版需要传递此字段,查询详情和列表时响应此字段 |
| ref | String | 否 | 创建执行时,使用本字段设置使用的模版id |
| name | String | 是 | 模板名称,不允许重复 |
| type | String | 否 | 模板类型,可选值:INDIVIDUAL(个人模板),GLOBAL(系统模板) |
| description | String | 否 | 模板描述 |
| tags | List<KeyValuePair> | 否 | 模板标签 |
| linear | Boolean | 否 | 任务是否串行执行,默认false |
| parallelism | int | 否 | 并发度 |
| operators | List<Operator> | 是 | 模板任务步骤列表 |
| links | List<LinkModel> | 否 | 描述 operator 之间的拓扑关系,linear=false 时必填 |
| properties | List<Property> | 否 | 全局参数列表 |
| updatedTime | String | 否 | 最后更新时间,查询详情和列表接口返回 |
| supportedInstanceTypes | List<String> | 否 | 支持的实例类型列表,目前仅用于系统模版 |
TemplatePage
| 参数名称 | 类型 | 描述 |
|---|---|---|
| templates | List<Template> | 模板列表 |
| orderBy | String | 排序字段 |
| order | String | 排序方向 asc/desc |
| pageNo | int | 页数 |
| pageSize | int | 每页展示数量 |
| totalCount | int | 总数量 |
评价此篇文章
