AlarmGroup
告警规则接收人配置
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AlarmEscalationRecipientIds | Array of String | 否 | 告警升级人ID列表 若告警接收人或上级升级人未在告警间隔时间内确认告警,则会发送告警给下一级升级人。 |
AlarmEscalationInterval | Integer | 否 | 告警升级间隔 |
NotificationFatigue | NotificationFatigue | 否 | 告警通知疲劳配置 |
AlarmWays | Array of String | 否 | 告警渠道 1.邮件,2.短信,3.微信,4.语音,5.企业微信,6.Http,7.企业微信群 8 飞书群 9 钉钉群 10 Slack群 11 Teams群(默认1.邮件) 7.企业微信群 8 飞书群 9 钉钉群 10 Slack群 11 Teams群 只能选择一个渠道 |
WebHooks | Array of AlarmWayWebHook | 否 | 企业微信群/飞书群/钉钉群 /Slack群/Teams群的webhook地址列表 |
AlarmRecipientType | Integer | 否 | 告警接收人类型:1.指定人员,2.任务责任人,3.值班表(默认1.指定人员) |
AlarmRecipientIds | Array of String | 否 | 根据AlarmRecipientType的类型该列表具有不同的业务id 1(指定人员): 告警接收人id列表 2(任务责任人):无需配置 3(值班表):值班表id列表 |
AlarmMessage
告警信息
被如下接口引用:GetAlarmMessage, ListAlarmMessages。
名称 | 类型 | 描述 |
---|---|---|
AlarmMessageId | Integer | 告警消息Id 示例值:115987 |
AlarmTime | String | 告警时间,同一条告警可能发送多次,只显示最新的告警时间 示例值:2025-08-07 16:00:00 |
TaskName | String | 任务名称 示例值:succ_task1 |
TaskId | String | 任务Id 示例值:20250326112047650 |
CurRunDate | String | 任务的实例数据时间 示例值:2025-09-08 15:00:00 |
AlarmReason | String | 告警原因 示例值:4 |
AlarmLevel | Integer | 告警级别,1.普通, 2.重要,3.紧急 示例值:1 |
AlarmRuleId | String | 告警规则Id 示例值:51d5c5f0-c88a-4c4a-ba0f-4175af27ad96 |
AlarmWays | Array of String | 告警渠道 1.邮件,2.短信,3.微信,4.语音,5.企业微信,6.Http,7.企业微信群, 8.飞书群,9.钉钉群,10.Slack群,11.Teams群(默认1.邮件),7.企业微信群,8.飞书群,9.钉钉群,10.Slack群,11.Teams群 示例值:["email","sms"] |
AlarmRecipients | Array of String | 告警接收人 示例值:["mytestdd"] |
AlarmQuietInterval
告警免打扰时间区间
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DaysOfWeek | Array of Integer | 否 | ISO标准,1表示周一,7表示周日。 示例值:[1, 2] |
StartTime | String | 否 | 开始时间,精度时分秒,格式 HH:mm:ss 示例值:01:01:01 |
EndTime | String | 否 | 结束时间,精度时分秒,格式 HH:mm:ss 示例值:02:01:01 |
AlarmRuleData
告警规则详情
被如下接口引用:GetOpsAlarmRule, ListOpsAlarmRules。
名称 | 类型 | 描述 |
---|---|---|
AlarmRuleId | String | 告警规则id 示例值:5466614e****a681e5a |
AlarmRuleName | String | 告警规则名称 示例值:RuleName |
Description | String | 告警规则描述 示例值:this is description |
MonitorObjectType | Integer | 监控对象类型, 任务维度监控: 可按照任务/工作流/项目来配置:1.任务、2.工作流、3.项目(默认为1.任务) 项目维度监控: 项目整体任务波动告警, 7:项目波动监控告警 |
MonitorObjectIds | Array of String | 根据MonitorType 的设置传入不同的业务id,如下1(任务): MonitorObjectIds为任务id列表2(工作流): MonitorObjectIds 为工作流id列表(工作流id可从接口ListWorkflows获取)3(项目): MonitorObjectIds为项目id列表 示例值:["2023***597"] |
AlarmTypes | Array of String | 告警规则监控类型 failure:失败告警 ;overtime:超时告警 success:成功告警; backTrackingOrRerunSuccess: 补录重跑成功告警 backTrackingOrRerunFailure:补录重跑失败告警; 项目波动告警 projectFailureInstanceUpwardFluctuationAlarm: 当天失败实例数向上波动率超过阀值告警; projectSuccessInstanceDownwardFluctuationAlarm:当天成功实例数向下波动率超过阀值告警; 离线集成任务对账告警: reconciliationFailure: 离线对账任务失败告警 reconciliationOvertime: 离线对账任务运行超时告警 reconciliationMismatch: 数据对账任务不一致条数超过阀值告警 示例值:["failure"] |
Status | Integer | 告警规则是否启用 0-- 禁用 1--启用 示例值:0 |
AlarmRuleDetail | AlarmRuleDetail | 告警规则配置信息 成功告警无需配置;失败告警可以配置首次失败告警或者所有重试失败告警;超时配置需要配置超时类型及超时阀值;项目波动告警需要配置波动率及防抖周期配置 |
AlarmLevel | Integer | 告警级别 1.普通、2.重要、3.紧急 示例值:1 |
OwnerUin | String | 告警规则创建人uid |
BundleId | String | bundle 客户端绑定的告警规则: 为空是正常的告警规则,不为空则是对应bundle客户端绑定的规则 注意:此字段可能返回 null,表示取不到有效值。 |
BundleInfo | String | bundleId不为空 则表示绑定的bundle客户端名称 注意:此字段可能返回 null,表示取不到有效值。 |
AlarmGroups | Array of AlarmGroup | 告警接收人配置列表 |
AlarmRuleDetail
告警规则详细配置
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Trigger | Integer | 否 | 失败触发时机 1 – 首次失败触发 2 --所有重试完成触发 (默认) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DataBackfillOrRerunTrigger | Integer | 否 | 补录重跑触发时机 1 – 首次失败触发 2 – 所有重试完成触发 注意:此字段可能返回 null,表示取不到有效值。 |
TimeOutExtInfo | Array of TimeOutStrategyInfo | 否 | 周期实例超时配置明细 注意:此字段可能返回 null,表示取不到有效值。 |
DataBackfillOrRerunTimeOutExtInfo | Array of TimeOutStrategyInfo | 否 | 重跑补录实例超时配置明细 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectInstanceStatisticsAlarmInfoList | Array of ProjectInstanceStatisticsAlarmInfo | 否 | 项目波动告警配置明细 注意:此字段可能返回 null,表示取不到有效值。 |
ReconciliationExtInfo | Array of ReconciliationStrategyInfo | 否 | 离线集成对账告警配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
AlarmWayWebHook
告警渠道 企业微信群/钉钉群/飞书群 等webhook地址配置
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AlarmWay | String | 否 | 告警渠道值 7.企业微信群,8 飞书群 9 钉钉群 10 Slack群 11 Teams群 示例值:7 |
WebHooks | Array of String | 否 | 告警群的webhook地址列表 示例值:["https://open****"] |
BackfillInstance
单次补录实例详情
被如下接口引用:ListDataBackfillInstances。
名称 | 类型 | 描述 |
---|---|---|
TaskName | String | 任务名称 示例值:replenishment_test |
TaskId | String | 任务Id 示例值:20250807170933305 |
CurRunDate | String | 实例数据时间 示例值:2025-08-07 15:40:00 |
State | String | 执行状态 示例值:COMPLETED |
StartTime | String | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-07 15:46:04 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-07 15:52:09 |
CostTime | String | 执行时长 注意:此字段可能返回 null,表示取不到有效值。 示例值:00:06:05.000 |
BackfillInstanceCollection
补录计划的所有实例
被如下接口引用:ListDataBackfillInstances。
名称 | 类型 | 描述 |
---|---|---|
PageNumber | Integer | 分页页码 |
PageSize | Integer | 分页大小 |
TotalPageNumber | Integer | 总页数 |
TotalCount | Integer | 记录总数 |
Items | Array of BackfillInstance | 补录实例列表 |
ChildDependencyConfigPage
任务下游依赖详情分页
被如下接口引用:ListDownstreamOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 结果总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
TotalPageNumber | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of OpsTaskDepend | 分页数据 注意:此字段可能返回 null,表示取不到有效值。 |
CodeFile
数据探索脚本业务处理实体
被如下接口引用:CreateCodeFile, GetCodeFile, UpdateCodeFile。
名称 | 类型 | 描述 |
---|---|---|
CodeFileId | String | 脚本ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:41da32a9-865d-42a8-93c0-3cf205c66190 |
CodeFileName | String | 脚本名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:数据工程师.bat |
OwnerUin | String | 脚本所有者 uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100041136799 |
CodeFileConfig | CodeFileConfig | 脚本配置 注意:此字段可能返回 null,表示取不到有效值。 |
CodeFileContent | String | 脚本内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"name":"1234"} |
UpdateUserUin | String | 最近一次操作人 注意:此字段可能返回 null,表示取不到有效值。 示例值:100041136799 |
ProjectId | String | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1464962169590902784 |
UpdateTime | String | 更新时间 yyyy-MM-dd hh:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-09-18 18:29:13 |
CreateTime | String | 创建时间 yyyy-MM-dd hh:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-09-17 19:26:30 |
AccessScope | String | 权限范围:SHARED, PRIVATE 注意:此字段可能返回 null,表示取不到有效值。 示例值:SHARED |
Path | String | 节点全路径,/aaa/bbb/ccc.ipynb,由各个节点的名称组成 注意:此字段可能返回 null,表示取不到有效值。 示例值:/mereditest/batfile/数据工程师.bat |
CodeFileConfig
数据探索脚本配置
被如下接口引用:CreateCodeFile, GetCodeFile, UpdateCodeFile。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Params | String | 否 | 高级运行参数,变量替换,map-json String,String 注意:此字段可能返回 null,表示取不到有效值。 |
NotebookSessionInfo | NotebookSessionInfo | 否 | notebook kernel session信息 注意:此字段可能返回 null,表示取不到有效值。 |
CodeFolderNode
数据探索脚本文件树节点
被如下接口引用:ListCodeFolderContents。
名称 | 类型 | 描述 |
---|---|---|
Id | String | 唯一标识 示例值:d5226c07-d079-448b-8262-7dd2a882d3f6 |
Title | String | 名称 示例值:test2 |
Type | String | 类型 folder,script 示例值:folder |
IsLeaf | Boolean | 是否叶子节点 示例值:true |
Params | String | 业务参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:'{"afd":"cwe"}' |
AccessScope | String | 权限范围: SHARED, PRIVATE 注意:此字段可能返回 null,表示取不到有效值。 示例值:SHARED |
Path | String | 节点路径 示例值:/000112x_10121/111.ipynb |
OwnerUin | String | 目录/文件责任人uin 示例值:100041136802 |
CreateUserUin | String | 创建人 示例值:100028650795 |
NodePermission | String | 当前用户对节点拥有的权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:CAN_MANAGE |
Children | Array of CodeFolderNode | 子节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
CodeStudioFileActionResult
CodeStudio文件对象操作结果
被如下接口引用:DeleteCodeFile。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 成功true,失败false 注意:此字段可能返回 null,表示取不到有效值。 |
CodeFileId | String | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 |
CodeStudioFolderActionResult
CodeStudio文件夹对象操作结果
被如下接口引用:DeleteCodeFolder, UpdateCodeFolder。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 成功true,失败false 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 |
CodeStudioFolderResult
CodeStudio文件夹对象操作结果
被如下接口引用:CreateCodeFolder。
名称 | 类型 | 描述 |
---|---|---|
FolderId | String | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 |
CreateAlarmRuleData
创建告警规则响应结果
被如下接口引用:CreateOpsAlarmRule。
名称 | 类型 | 描述 |
---|---|---|
AlarmRuleId | String | 告警规则唯一id 示例值:b84aa****89f2de |
CreateDataReplenishmentPlan
创建数据补录计划结果
被如下接口引用:CreateDataBackfillPlan。
名称 | 类型 | 描述 |
---|---|---|
DataBackfillPlanId | String | 补录计划Id |
CreateFolderResult
创建文件夹结果
被如下接口引用:CreateResourceFolder, CreateWorkflowFolder。
名称 | 类型 | 描述 |
---|---|---|
FolderId | String | 创建成功的文件夹ID。如果创建失败则报错。 |
CreateResourceFileResult
创建资源文件结果
被如下接口引用:CreateResourceFile。
名称 | 类型 | 描述 |
---|---|---|
ResourceId | String | 资源文件ID |
CreateTaskBaseAttribute
创建任务基本属性信息
被如下接口引用:CreateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskName | String | 是 | 任务名称 示例值:sh_api_250827_205043 |
TaskTypeId | String | 是 | 任务类型ID: * 21:JDBC SQL * 23:TDSQL-PostgreSQL * 26:OfflineSynchronization * 30:Python * 31:PySpark * 32:DLC SQL * 33:Impala * 34:Hive SQL * 35:Shell * 36:Spark SQL * 38:Shell Form Mode * 39:Spark * 40:TCHouse-P * 41:Kettle * 42:Tchouse-X * 43:TCHouse-X SQL * 46:DLC Spark * 47:TiOne * 48:Trino * 50:DLC PySpark * 92:MapReduce * 130:Branch Node * 131:Merged Node * 132:Notebook * 133:SSH * 134:StarRocks * 137:For-each * 138:Setats SQL 示例值:35 |
WorkflowId | String | 是 | 工作流ID 示例值:09cfab2c-8d4d-45e5-8af5-80b82f87ccb4 |
OwnerUin | String | 否 | 任务负责人ID,默认为当前用户 示例值:100028571357 |
TaskDescription | String | 否 | 任务描述 示例值:this is a shell task! |
CreateTaskConfiguration
创建任务配置信息
被如下接口引用:CreateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ResourceGroup | String | 否 | 资源组ID: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId 示例值:20240222212719833743 |
CodeContent | String | 否 | 代码内容的Base64编码 示例值:cHJpbnQoJ2hlbGxvIHdvcmxkIScp |
TaskExtConfigurationList | Array of TaskExtParameter | 否 | 任务扩展属性配置列表 |
DataCluster | String | 否 | 集群ID 示例值:2568295b-56ac-4a74-8b37-4c8b17545353 |
BrokerIp | String | 否 | 指定的运行节点 示例值:any |
YarnQueue | String | 否 | 资源池队列名称,需要通过 DescribeProjectClusterQueues 获取 示例值:default |
SourceServiceId | String | 否 | 来源数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 示例值:8444 |
TargetServiceId | String | 否 | 目标数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 示例值:61933 |
TaskSchedulingParameterList | Array of TaskSchedulingParameter | 否 | 调度参数 |
BundleId | String | 否 | Bundle使用的ID 示例值:1 |
BundleInfo | String | 否 | Bundle信息 示例值:{"BundleName":"test", BundlePath:"/test"} |
CreateTaskResult
创建任务返回体
被如下接口引用:CreateTask。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20250827172510504 |
CreateTaskSchedulerConfiguration
创建任务调度配置信息
被如下接口引用:CreateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CycleType | String | 否 | 周期类型:默认为 DAY_CYCLE 支持的类型为 * ONEOFF_CYCLE: 一次性 * YEAR_CYCLE: 年 * MONTH_CYCLE: 月 * WEEK_CYCLE: 周 * DAY_CYCLE: 天 * HOUR_CYCLE: 小时 * MINUTE_CYCLE: 分钟 * CRONTAB_CYCLE: crontab表达式类型 示例值:DAY_CYCLE |
ScheduleTimeZone | String | 否 | 时区,默认为 UTC+8 示例值:UTC+8 |
CrontabExpression | String | 否 | Cron表达式,默认为 0 0 0 * * ? * 示例值:0 0 0 * * ? * |
StartTime | String | 否 | 生效日期,默认为当前日期的 00:00:00 示例值:2025-08-26 00:00:00 |
EndTime | String | 否 | 结束日期,默认为 2099-12-31 23:59:59 示例值:2099-12-31 23:59:59 |
ExecutionStartTime | String | 否 | 执行时间 左闭区间,默认 00:00 示例值:00:00 |
ExecutionEndTime | String | 否 | 执行时间 右闭区间,默认 23:59 示例值:23:59 |
ScheduleRunType | String | 否 | 调度类型: 0 正常调度 1 空跑调度,默认为 0 示例值:0 |
CalendarOpen | String | 否 | 日历调度 取值为 0 和 1, 1为打开,0为关闭,默认为0 示例值:0 |
CalendarId | String | 否 | 日历调度 日历 ID 示例值:26 |
SelfDepend | String | 否 | 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序) 示例值:serial |
UpstreamDependencyConfigList | Array of DependencyTaskBrief | 否 | 上游依赖数组 |
EventListenerList | Array of EventListener | 否 | 事件数组 |
RunPriority | String | 否 | 任务调度优先级 运行优先级 4高 5中 6低 , 默认:6 示例值:6 |
RetryWait | String | 否 | 重试策略 重试等待时间,单位分钟: 默认: 5 示例值:5 |
MaxRetryAttempts | String | 否 | 重试策略 最大尝试次数, 默认: 4 示例值:4 |
ExecutionTTL | String | 否 | 超时处理策略 运行耗时超时(单位:分钟)默认为 -1 示例值:-1 |
WaitExecutionTotalTTL | String | 否 | 超时处理策略 等待总时长耗时超时(单位:分钟)默认为 -1 示例值:-1 |
AllowRedoType | String | 否 | 重跑&补录配置, 默认为 ALL; , ALL 运行成功或失败后皆可重跑或补录, FAILURE 运行成功后不可重跑或补录,运行失败后可重跑或补录, NONE 运行成功或失败后皆不可重跑或补录; 示例值:ALL |
ParamTaskOutList | Array of OutTaskParameter | 否 | 输出参数数组 |
ParamTaskInList | Array of InTaskParameter | 否 | 输入参数数组 |
TaskOutputRegistryList | Array of TaskDataRegistry | 否 | 产出登记 |
InitStrategy | String | 否 | 实例生成策略 * T_PLUS_0: T+0生成,默认策略 * T_PLUS_1: T+1生成 示例值:T_PLUS_0 |
CreateWorkflowResult
创建工作流结果
被如下接口引用:CreateWorkflow。
名称 | 类型 | 描述 |
---|---|---|
WorkflowId | String | 创建成功后的工作流id |
DataBackfillRange
补录计划日期范围
被如下接口引用:CreateDataBackfillPlan。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StartDate | String | 否 | 开始日期,格式yyyy-MM-dd 表示从指定日期的00:00:00开始 注意:此字段可能返回 null,表示取不到有效值。 |
EndDate | String | 否 | 结束日期,格式yyyy-MM-dd,表示从指定日期的 23:59:59结束 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionStartTime | String | 否 | 在[StartDate, EndDate]之间每天的开始时间点,格式HH:mm,只针对小时及周期小于小时的任务生效 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionEndTime | String | 否 | 在[StartDate, EndDate]之间每天的结束时间点,格式HH:mm,只针对小时及周期小于小时的任务生效 注意:此字段可能返回 null,表示取不到有效值。 |
DeleteAlarmRuleResult
删除告警规则响应结果
被如下接口引用:DeleteOpsAlarmRule。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 是否删除成功 |
DeleteFolderResult
删除资源文件夹结果
被如下接口引用:DeleteResourceFolder, DeleteWorkflowFolder。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 删除状态,true表示成功,false表示失败 示例值:true |
DeleteResourceFileResult
删除资源文件结果
被如下接口引用:DeleteResourceFile。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | true |
DeleteTaskResult
删除数据开发任务结果
被如下接口引用:DeleteTask。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 删除状态,true表示成功,false表示失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
DeleteWorkflowResult
删除工作流结果
被如下接口引用:DeleteWorkflow。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 删除工作流是否成功 |
DependencyConfigPage
查询任务上游依赖详情分页
被如下接口引用:ListDownstreamTasks, ListUpstreamTasks。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 满足查询条件的数据总条数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalPageNumber | Integer | 满足查询条件的数据总页数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageNumber | Integer | 当前请求的数据页数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 当前请求的数据页条数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
Items | Array of TaskDependDto | 分页数据 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyStrategyTask
依赖配置策略
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PollingNullStrategy | String | 否 | 等待上游任务实例策略:EXECUTING(执行);WAITING(等待) 注意:此字段可能返回 null,表示取不到有效值。 示例值:EXECUTING |
TaskDependencyExecutingStrategies | Array of String | 否 | 仅当PollingNullStrategy为EXECUTING时才需要填本字段,List类型:NOT_EXIST(默认,在分钟依赖分钟/小时依赖小时的情况下,父实例不在下游实例调度时间范围内);PARENT_EXPIRED(父实例失败);PARENT_TIMEOUT(父实例超时)。以上场景满足任一条件即可通过该父任务实例依赖判断,除以上场景外均需等待父实例。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["PARENT_TIMEOUT"] |
TaskDependencyExecutingTimeoutValue | Integer | 否 | 仅当TaskDependencyExecutingStrategies中包含PARENT_TIMEOUT时才需要填本字段,下游任务依赖父实例执行超时时间,单位:分钟。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DependencyTaskBrief
依赖任务信息
取值说明表:
当前任务周期类型 | 上游任务周期类型 | 配置方式 | MainCyclicConfig取值 | 时间维度/实例范围 | SubordinateCyclicConfig取值 | offset取值 |
---|---|---|---|---|---|---|
HOUR_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
MINUTE_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
DAY_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
DAY_CYCLE | WEEK_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
HOUR_CYCLE | HOUR_CYCLE | 推荐策略 | HOUR | 按小时/最近实例 | CURRENT_HOUR | 无 |
HOUR_CYCLE | HOUR_CYCLE | 推荐策略 | HOUR | 按小时/前一周期 | PREVIOUS_HOUR_CYCLE | 无 |
HOUR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/上周 | PREVIOUS_WEEK | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/上周五 | PREVIOUS_FRIDAY | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/上周日 | PREVIOUS_WEEKEND | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 、 | CURRENT_DAY | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
WEEK_CYCLE | ONEOFF_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
HOUR_CYCLE | MINUTE_CYCLE | 推荐策略 | HOUR | 按小时/前一个小时(-60,0] | PREVIOUS_HOUR_LATER_OFFSET_MINUTE | 无 |
HOUR_CYCLE | MINUTE_CYCLE | 推荐策略 | HOUR | 按小时/前一个小时 | PREVIOUS_HOUR | 无 |
HOUR_CYCLE | MINUTE_CYCLE | 推荐策略 | HOUR | 按小时/当前小时 | CURRENT_HOUR | 无 |
YEAR_CYCLE | WEEK_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
WEEK_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
MINUTE_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
WEEK_CYCLE | HOUR_CYCLE | 推荐策略 | WEEK | 按周/上周 | PREVIOUS_WEEK | 无 |
WEEK_CYCLE | HOUR_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
MINUTE_CYCLE | HOUR_CYCLE | 推荐策略 | HOUR | 按小时/当前小时 | CURRENT_HOUR | 无 |
HOUR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | HOUR_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | HOUR_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | ONEOFF_CYCLE | 推荐策略 | MONTH | 按月/当月 | CURRENT_MONTH | 无 |
DAY_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
DAY_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
MONTH_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
ONEOFF_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
MINUTE_CYCLE | MINUTE_CYCLE | 推荐策略 | MINUTE | 按分钟/当前分钟 | CURRENT_MINUTE | 无 |
MINUTE_CYCLE | MINUTE_CYCLE | 推荐策略 | MINUTE | 按分钟/前一周期 | PREVIOUS_MINUTE_CYCLE | 无 |
YEAR_CYCLE | MINUTE_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
ONEOFF_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
DAY_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/前一天(-24 * 60,0] | PREVIOUS_DAY_LATER_OFFSET_MINUTE | 无 |
DAY_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
DAY_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
MINUTE_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
WEEK_CYCLE | WEEK_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | YEAR_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
YEAR_CYCLE | HOUR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
MINUTE_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
ONEOFF_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
HOUR_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | MINUTE_CYCLE | 推荐策略 | WEEK | 按周/上周 | PREVIOUS_WEEK | 无 |
WEEK_CYCLE | MINUTE_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
DAY_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/前一天(-24,0] | PREVIOUS_DAY_LATER_OFFSET_HOUR | 无 |
DAY_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/前一天[-24,0) | PREVIOUS_DAY | 无 |
DAY_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本年所有月 | ALL_MONTH_OF_YEAR | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/上月末 | PREVIOUS_END_OF_MONTH | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/上月初 | PREVIOUS_BEGIN_OF_MONTH | 无 |
ONEOFF_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
DAY_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
ONEOFF_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
DAY_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
MINUTE_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
WEEK_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | ONEOFF_CYCLE | 推荐策略 | YEAR | 按年/当年 | CURRENT_YEAR | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | MONTH | 按月/上月末 | PREVIOUS_END_OF_MONTH | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
YEAR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/本年所有天 | ALL_DAY_OF_YEAR | 无 |
YEAR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
YEAR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
HOUR_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
MONTH_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/当月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
MONTH_CYCLE | MINUTE_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | MINUTE_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | WEEK_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | WEEK_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | WEEK_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
DAY_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
DAY_CYCLE | YEAR_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
ONEOFF_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
ONEOFF_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
CRONTAB_CYCLE | CRONTAB_CYCLE | 推荐策略 | CRONTAB | 无 | CURRENT | 无 |
HOUR_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:250814205035 |
MainCyclicConfig | String | 是 | 主依赖配置,取值为: * CRONTAB * DAY * HOUR * LIST_DAY * LIST_HOUR * LIST_MINUTE * MINUTE * MONTH * RANGE_DAY * RANGE_HOUR * RANGE_MINUTE * WEEK * YEAR 注意:此字段可能返回 null,表示取不到有效值。 示例值:DAY |
SubordinateCyclicConfig | String | 否 | 次依赖配置,取值为: * ALL_DAY_OF_YEAR * ALL_MONTH_OF_YEAR * CURRENT * CURRENT_DAY * CURRENT_HOUR * CURRENT_MINUTE * CURRENT_MONTH * CURRENT_WEEK * CURRENT_YEAR * PREVIOUS_BEGIN_OF_MONTH * PREVIOUS_DAY * PREVIOUS_DAY_LATER_OFFSET_HOUR * PREVIOUS_DAY_LATER_OFFSET_MINUTE * PREVIOUS_END_OF_MONTH * PREVIOUS_FRIDAY * PREVIOUS_HOUR * PREVIOUS_HOUR_CYCLE * PREVIOUS_HOUR_LATER_OFFSET_MINUTE * PREVIOUS_MINUTE_CYCLE * PREVIOUS_MONTH * PREVIOUS_WEEK * PREVIOUS_WEEKEND * RECENT_DATE 注意:此字段可能返回 null,表示取不到有效值。 示例值:CURRENT_DAY |
Offset | String | 否 | 区间、列表模式下的偏移量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0,1 |
DependencyStrategy | DependencyStrategyTask | 否 | 依赖执行策略 注意:此字段可能返回 null,表示取不到有效值。 |
EventListener
监听事件器
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EventName | String | 是 | 事件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_auto111 |
EventSubType | String | 是 | 事件周期:SECOND, MIN, HOUR, DAY 注意:此字段可能返回 null,表示取不到有效值。 示例值:DAY |
EventBroadcastType | String | 是 | 事件广播类型:SINGLE, BROADCAST 注意:此字段可能返回 null,表示取不到有效值。 示例值:BROADCAST |
PropertiesList | Array of ParamInfo | 否 | 扩展信息 注意:此字段可能返回 null,表示取不到有效值。 |
InTaskParameter
参数传递-引用参数
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 注意:此字段可能返回 null,表示取不到有效值。 示例值:intask_v |
ParamDesc | String | 是 | 参数描述:格式为 项目标识.任务名称.参数名;例:project_wedata_1.sh_250820_104107.pp_out 注意:此字段可能返回 null,表示取不到有效值。 示例值:DATA_DEV_SIM_PROJ_01.sh_241204_111248.taskout_v1 |
FromTaskId | String | 是 | 父任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20241204111252781 |
FromParamKey | String | 是 | 父任务参数key 注意:此字段可能返回 null,表示取不到有效值。 示例值:taskout_v1 |
InstanceExecution
调度实例详情
被如下接口引用:ListTaskInstanceExecutions。
名称 | 类型 | 描述 |
---|---|---|
InstanceKey | String | 实例唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240627201611119_2025-03-20 00:00:00 |
LifeRoundNum | Integer | 实例生命周期编号,标识实例的某一次执行 例如:周期实例第一次运行的编号为0,用户后期又重跑了该实例,第二次执行的编号为1 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
InstanceState | String | 实例状态 - WAIT_EVENT: 等待事件 - WAIT_UPSTREAM: 等待上游 - WAIT_RUN: 等待运行 - RUNNING: 运行中 - SKIP_RUNNING: 跳过运行 - FAILED_RETRY: 失败重试 - EXPIRED: 失败 - COMPLETED: 成功 注意:此字段可能返回 null,表示取不到有效值。 |
RunType | String | 实例运行触发类型 - RERUN 表示重跑 - ADDITION 表示补录 - PERIODIC 表示周期 - APERIODIC 表示非周期 - RERUN_SKIP_RUN 表示重跑 - 空跑 - ADDITION_SKIP_RUN 表示补录 - 空跑 - PERIODIC_SKIP_RUN 表示周期 - 空跑 - APERIODIC_SKIP_RUN 表示非周期 - 空跑 - MANUAL_TRIGGER 表示手动触发 - RERUN_MANUAL_TRIGGER 表示手动触发 - 重跑 注意:此字段可能返回 null,表示取不到有效值。 示例值:PERIODIC |
Tries | Integer | 失败重试次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ExecutionPhaseList | Array of InstanceExecutionPhase | 实例执行生命周期列表 注意:此字段可能返回 null,表示取不到有效值。 |
CostTime | Integer | 耗费时间, 单位ms 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
InstanceExecutionPhase
实例执行的每个阶段详情
被如下接口引用:ListTaskInstanceExecutions。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StartTime | String | 否 | 该状态开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-28 00:00:00 |
DetailState | String | 否 | 实例生命周期阶段状态 - WAIT_UPSTREAM 表示 等待事件/上游状态 - WAIT_RUN 表示 等待运行状态 - RUNNING 表示 运行中状态 - COMPLETE 表示 终态-完成 - FAILED 表示 终态-失败重试 - EXPIRED 表示 终态-失败 - SKIP_RUNNING 表示 终态-被上游分支节点跳过的分支 - HISTORY 表示 兼容2024-03-30之前的历史实例,之后实例无需关注次枚举类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:RUNNING |
EndTime | String | 否 | 该状态结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-28 00:00:05 |
InstanceLog
实例日志内容
被如下接口引用:GetTaskInstanceLog。
名称 | 类型 | 描述 |
---|---|---|
InstanceKey | String | 实例唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240627201611119_2025-03-20 00:00:00 |
ProjectId | String | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1531612696090365952 |
CodeContent | String | 运行代码内容 注意:此字段可能返回 null,表示取不到有效值。 |
LogInfo | String | 日志内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:[INFO] echo 1 |
NextCursor | String | 分页查询日志时使用,无具体业务含义 第一次查询时值为null 第二次及以后查询时使用上一次查询返回信息中的NextCursor字段值即可 注意:此字段可能返回 null,表示取不到有效值。 示例值:115715 |
JobDto
数据探索任务JOB
被如下接口引用:ListSQLScriptRuns, RunSQLScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
JobId | String | 否 | 数据探索任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
JobName | String | 否 | 数据探索任务名称 注意:此字段可能返回 null,表示取不到有效值。 |
JobType | String | 否 | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptId | String | 否 | 脚本ID 注意:此字段可能返回 null,表示取不到有效值。 |
JobExecutionList | Array of JobExecutionDto | 否 | 子任务列表 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptContent | String | 否 | 脚本内容 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 否 | 任务状态 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 任务创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUin | String | 否 | 云主账号UIN 注意:此字段可能返回 null,表示取不到有效值。 |
UserUin | String | 否 | 账号UIN 注意:此字段可能返回 null,表示取不到有效值。 |
TimeCost | Integer | 否 | 耗时 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptContentTruncate | Boolean | 否 | 是否脚本内容被截断 注意:此字段可能返回 null,表示取不到有效值。 |
JobExecutionDto
业务提交JOB的子任务
被如下接口引用:ListSQLScriptRuns, RunSQLScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
JobId | String | 是 | 数据探索任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
JobExecutionId | String | 是 | 子查询任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
JobExecutionName | String | 是 | 子查询名称 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptContent | String | 是 | 子查询sql内容 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 是 | 子查询状态 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 是 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ExecuteStageInfo | String | 否 | 执行阶段 注意:此字段可能返回 null,表示取不到有效值。 |
LogFilePath | String | 否 | 日志路径 注意:此字段可能返回 null,表示取不到有效值。 |
ResultFilePath | String | 否 | 下载结果路径 注意:此字段可能返回 null,表示取不到有效值。 |
ResultPreviewFilePath | String | 否 | 预览结果路径 注意:此字段可能返回 null,表示取不到有效值。 |
ResultTotalCount | Integer | 否 | 任务执行的结果总行数 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
TimeCost | Integer | 否 | 耗时 注意:此字段可能返回 null,表示取不到有效值。 |
ContextScriptContent | Array of String | 否 | 上下文SQL内容 注意:此字段可能返回 null,表示取不到有效值。 |
ResultPreviewCount | Integer | 否 | 任务执行的结果预览行数 注意:此字段可能返回 null,表示取不到有效值。 |
ResultEffectCount | Integer | 否 | 任务执行的结果影响行数 注意:此字段可能返回 null,表示取不到有效值。 |
CollectingTotalResult | Boolean | 否 | 是否正在收集全量结果:默认false,true表示正在收集全量结果,用于前端判断是否需要继续轮询 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptContentTruncate | Boolean | 否 | 是否需要截断脚本内容 注意:此字段可能返回 null,表示取不到有效值。 |
KVMap
map
被如下接口引用:RerunTaskInstancesAsync。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
K | String | 否 | k 注意:此字段可能返回 null,表示取不到有效值。 |
V | String | 否 | v 注意:此字段可能返回 null,表示取不到有效值。 |
KVPair
键值对
被如下接口引用:CreateDataBackfillPlan。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
K | String | 否 | 键名 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
V | String | 否 | 值,请勿传SQL(请求会被视为攻击接口),如果有需要,请将SQL进行Base64转码并解码。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Tom |
ListAlarmMessages
告警信息列表
被如下接口引用:ListAlarmMessages。
名称 | 类型 | 描述 |
---|---|---|
PageNumber | Integer | 页码 示例值:1 |
PageSize | Integer | 分页大小 示例值:20 |
TotalCount | Integer | 总条数 示例值:100 |
TotalPageNumber | Integer | 总页数 |
Items | Array of AlarmMessage | 告警信息列表 |
ListAlarmRulesResult
查询告警规则列表
被如下接口引用:ListOpsAlarmRules。
名称 | 类型 | 描述 |
---|---|---|
PageNumber | Integer | 分页的页数,当前页数 示例值:1 |
PageSize | Integer | 每页显示的条数 |
TotalPageNumber | Integer | 分页总页数 |
TotalCount | Integer | 所有的告警规则个数 |
Items | Array of AlarmRuleData | 告警规则信息列表 |
ListOpsTasksPage
任务列表分页
被如下接口引用:ListOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 结果总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
TotalPageNumber | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
Items | Array of TaskOpsInfo | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
ListTaskInfo
查询任务信息分页
被如下接口引用:ListTasks。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of TaskBaseAttribute | 任务数组 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 当前请求的数据页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 当前请求的数据页条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalCount | Integer | 满足查询条件的数据总条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
TotalPageNumber | Integer | 满足查询条件的数据总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
ListTaskVersions
查询任务版本分页列表
被如下接口引用:ListTaskVersions。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of TaskVersion | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 满足查询条件的数据总条数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalPageNumber | Integer | 满足查询条件的数据总页数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageCount | Integer | 当前页记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 当前请求的数据页条数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
PageNumber | Integer | 当前请求的数据页数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ListWorkflowInfo
查询工作流分页列表
被如下接口引用:ListWorkflows。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of WorkflowInfo | 列表item 注意:此字段可能返回 null,表示取不到有效值。 |
TotalPageNumber | Integer | 满足查询条件的数据总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
PageNumber | Integer | 当前请求的数据页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 当前请求的数据页条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalCount | Integer | 满足查询条件的数据总条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:200 |
ModifyAlarmRuleResult
更新告警规则响应
被如下接口引用:UpdateOpsAlarmRule。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 是否更新成功 |
NotebookSessionInfo
notebook kernel session信息
被如下接口引用:CreateCodeFile, UpdateCodeFile。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
NotebookSessionId | String | 否 | 会话ID |
NotebookSessionName | String | 否 | 会话名称 |
NotificationFatigue
告警疲劳告警配置
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
NotifyCount | Integer | 否 | 告警次数 示例值:1 |
NotifyInterval | Integer | 否 | 告警间隔,分钟 示例值:5 |
QuietIntervals | Array of AlarmQuietInterval | 否 | 免打扰时间,例如示例值 [{DaysOfWeek: [1, 2], StartTime: "00:00:00", EndTime: "09:00:00"}] 每周一、周二的00:00到09:00免打扰 注意:此字段可能返回 null,表示取不到有效值。 |
OpsAsyncJobDetail
异步操作详情
被如下接口引用:GetOpsAsyncJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ProjectId | String | 否 | 项目id 示例值:1531612696090365952 |
AsyncId | String | 否 | 操作id |
AsyncType | String | 否 | 异步操作类型 |
Status | String | 否 | 异步操作状态:初始状态: INIT; 运行中: RUNNING; 成功: SUCCESS; 失败: FAIL; 部分成功: PART_SUCCESS 示例值:SUCCESS |
ErrorDesc | String | 否 | 错误信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:invalid request |
TotalSubProcessCount | Integer | 否 | 子操作总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
FinishedSubProcessCount | Integer | 否 | 已完成的子操作个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
SuccessSubProcessCount | Integer | 否 | 已成功的子操作个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
CreateUserUin | String | 否 | 操作人id 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 操作创建时间 示例值:2025-08-08 19:42:40 |
UpdateTime | String | 否 | 更新时间 示例值:2025-08-08 19:42:40 |
OpsAsyncResponse
异步操作返回结构体
被如下接口引用:KillTaskInstancesAsync, PauseOpsTasksAsync, RerunTaskInstancesAsync, SetSuccessTaskInstancesAsync, StopOpsTasksAsync。
名称 | 类型 | 描述 |
---|---|---|
AsyncId | String | 异步执行记录Id |
OpsTaskDepend
依赖任务信息
被如下接口引用:ListDownstreamOpsTasks, ListUpstreamOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务Id 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 任务状态: - Y: 调度中 - F: 已下线 - O: 已暂停 - T: 下线中 - INVALID: 已失效 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeId | Integer | 任务类型Id: * 21:JDBC SQL * 23:TDSQL-PostgreSQL * 26:OfflineSynchronization * 30:Python * 31:PySpark * 33:Impala * 34:Hive SQL * 35:Shell * 36:Spark SQL * 38:Shell Form Mode * 39:Spark * 40:TCHouse-P * 41:Kettle * 42:Tchouse-X * 43:TCHouse-X SQL * 46:DLC Spark * 47:TiOne * 48:Trino * 50:DLC PySpark * 92:MapReduce * 130:Branch Node * 131:Merged Node * 132:Notebook * 133:SSH * 134:StarRocks * 137:For-each * 138:Setats SQL 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeDesc | String | 任务类型描述 - 20 : 通用数据同步 - 25 : ETLTaskType - 26 : ETLTaskType - 30 : python - 31 : pyspark - 34 : hivesql - 35 : shell - 36 : sparksql - 21 : jdbcsql - 32 : dlc - 33 : ImpalaTaskType - 40 : CDWTaskType - 41 : kettle - 42 : TCHouse-X - 43 : TCHouse-X SQL - 46 : dlcsparkTaskType - 47 : TiOneMachineLearningTaskType - 48 : Trino - 50 : DLCPyspark - 23 : TencentDistributedSQL - 39 : spark - 92 : MRTaskType - 38 : ShellScript - 70 : HiveSQLScrip - 130 : 分支 - 131 : 归并 - 132 : Notebook探索 - 133 : SSH节点 - 134 : StarRocks - 137 : For-each - 10000 : 自定义业务通用 注意:此字段可能返回 null,表示取不到有效值。 |
FolderName | String | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
FirstSubmitTime | String | 最近提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
FirstRunTime | String | 首次运行时间 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleDesc | String | 调度计划展示描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 任务周期类型 * ONEOFF_CYCLE: 一次性 * YEAR_CYCLE: 年 * MONTH_CYCLE: 月 * WEEK_CYCLE: 周 * DAY_CYCLE: 天 * HOUR_CYCLE: 小时 * MINUTE_CYCLE: 分钟 * CRONTAB_CYCLE: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUin | String | 负责人 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionStartTime | String | 执行开始时间, 格式HH:mm, 如00:00 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionEndTime | String | 执行结束时间, 格式HH:mm, 如23:59 注意:此字段可能返回 null,表示取不到有效值。 |
OpsWorkflow
工作流列表分页详情
被如下接口引用:ListOpsWorkflows。
名称 | 类型 | 描述 |
---|---|---|
TaskCount | Integer | 任务数量 示例值:1 |
FolderName | String | 文件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:示例文件名 |
FolderId | String | 工作流文件id 示例值:91df5247-677b-11f0-9366-7c8c09fca71c |
WorkflowId | String | 工作流id 示例值:8131486e-9274-4dac-999f-f36546325116 |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo |
WorkflowType | String | 工作流类型 - cycle周期 - manual手动 示例值:cycle |
WorkflowDesc | String | 工作流描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo |
OwnerUin | String | 负责人userId,多个‘;’隔开 注意:此字段可能返回 null,表示取不到有效值。 示例值:ryanrliao |
ProjectId | String | 项目id 示例值:20250227112841503 |
ProjectName | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:TestProjectName |
Status | String | 工作流状态 * ALL_RUNNING : 全部调度中 * ALL_FREEZED : 全部已暂停 * ALL_STOPPTED : 全部已下线 * PART_RUNNING : 部分调度中 * ALL_NO_RUNNING : 全部未调度 * ALL_INVALID : 全部已失效 示例值:ALL_RUNNING |
CreateTime | String | 工作流创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-06-25 20:05:59 |
UpdateTime | String | 最近更新时间, 包含开发、生产变更 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-09-14 11:41:32 |
UpdateUserUin | String | 最近更新人,包含开发、生产变更 注意:此字段可能返回 null,表示取不到有效值。 示例值:jasonzcwang |
OpsWorkflowDetail
工作流调度详情
被如下接口引用:GetOpsWorkflow。
名称 | 类型 | 描述 |
---|---|---|
WorkflowId | String | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:d953cf42-6ade-4b02-825f-0a045e2c459d |
WorkflowDesc | String | 工作流描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo |
WorkflowType | String | 工作流类型: - cycle 周期; - manual手动 注意:此字段可能返回 null,表示取不到有效值。 示例值:cycle |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-05-09 17:47:56 |
CreateUserUin | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 示例值:vin |
UpdateTime | String | 修改时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-05-09 17:47:56 |
StartupTime | Integer | 延时执行时间,unit=minute 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
StartTime | String | 配置生效日期 开始日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-11 16:36:49 |
EndTime | String | 配置结束日期 结束日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2099-12-31 23:59:59 |
CycleType | String | 任务周期类型 * ONEOFF_CYCLE: 一次性 * YEAR_CYCLE: 年 * MONTH_CYCLE: 月 * WEEK_CYCLE: 周 * DAY_CYCLE: 天 * HOUR_CYCLE: 小时 * MINUTE_CYCLE: 分钟 * CRONTAB_CYCLE: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:DAY_CYCLE |
FolderId | String | 文件夹Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:6445aa5a-7e58-11f0-9366-7c8c09fca71c |
InstanceInitStrategy | String | 任务实例初始化策略 - T_PLUS_1(T+1):延迟一天初始化 - T_PLUS_0(T+0):当天初始化 - T_MINUS_1(T-1):提前一天初始化 注意:此字段可能返回 null,表示取不到有效值。 示例值:T_PLUS_0 |
SchedulerDesc | String | 调度计划释义 注意:此字段可能返回 null,表示取不到有效值。 示例值:每天00:00执行一次 |
FirstSubmitTime | String | 工作流首次提交时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-06-25 20:07:15 |
LatestSubmitTime | String | 工作流最近提交时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-06-26 19:03:55 |
Status | String | 工作流状态 * ALL_RUNNING : 全部调度中 * ALL_FREEZED : 全部已暂停 * ALL_STOPPTED : 全部已下线 * PART_RUNNING : 部分调度中 * ALL_NO_RUNNING : 全部未调度 * ALL_INVALID : 全部已失效 注意:此字段可能返回 null,表示取不到有效值。 示例值:ALL_RUNNING |
OwnerUin | String | 负责人, 多个以‘;’隔开 注意:此字段可能返回 null,表示取不到有效值。 示例值:;100042680225; |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_yulingfan |
OpsWorkflows
查询工作流分页列表
被如下接口引用:ListOpsWorkflows。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of OpsWorkflow | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 结果总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
TotalPageNumber | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
PageNumber | Integer | 分页页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OutTaskParameter
参数传递-输出参数
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 注意:此字段可能返回 null,表示取不到有效值。 示例值:taskout_v1 |
ParamValue | String | 是 | 参数定义 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ParamInfo
参数
被如下接口引用:CreateTask, CreateWorkflow, GetOpsTask, GetTask, GetWorkflow, UpdateTask, UpdateWorkflow。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 示例值:aba |
ParamValue | String | 是 | 参数值 示例值:cab |
ParentDependencyConfigPage
查询任务上游依赖详情分页
被如下接口引用:ListUpstreamOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 结果总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
TotalPageNumber | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of OpsTaskDepend | 分页数据 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectInstanceStatisticsAlarmInfo
告警规则项目波动率告警配置信息
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AlarmType | String | 是 | 告警类型 projectFailureInstanceUpwardFluctuationAlarm: 失败实例向上波动告警 projectSuccessInstanceDownwardFluctuationAlarm: 成功实例向下波动告警 示例值:projectSuccessInstanceDownwardFluctuationAlarm |
InstanceThresholdCountPercent | Integer | 否 | 实例成功数向下波动比例告警阀值;实例失败数向上波动比例告警阀值 示例值:10 |
InstanceThresholdCount | Integer | 否 | 累计实例数波动阀值 示例值:10 |
StabilizeThreshold | Integer | 否 | 稳定性次数阈值(防抖动配置统计周期数) 示例值:1 |
StabilizeStatisticsCycle | Integer | 否 | 稳定性统计周期(防抖动配置统计周期数) 示例值:5 |
IsCumulant | Boolean | 否 | 是否累计计算,false:连续,true:累计 |
InstanceCount | Integer | 否 | 当日累计实例数; 当天失败实例数向下波动量 |
ReconciliationStrategyInfo
离线集成对账告警规则
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleType | String | 否 | 离线告警规则类型 reconciliationFailure: 离线对账失败告警 reconciliationOvertime: 离线对账任务运行超时告警(需配置超时时间) reconciliationMismatch: 离线对账不一致条数告警(需配置不一致条数阀值) 注意:此字段可能返回 null,表示取不到有效值。 |
MismatchCount | Integer | 否 | 对账不一致条数阀值, RuleType=reconciliationMismatch对账不一致条数类型,需要配置该字段,无默认值 注意:此字段可能返回 null,表示取不到有效值。 |
Hour | Integer | 否 | 对账任务运行超时阀值: 小时, 默认为0 注意:此字段可能返回 null,表示取不到有效值。 |
Min | Integer | 否 | 对账任务运行超时阀值: 分钟, 默认为1 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceFile
资源文件详情
被如下接口引用:GetResourceFile。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | String | 项目ID 示例值:1531609696090365952 |
ResourceId | String | 资源文件ID 示例值:ec921143-2fb0-435d-b646-5c8e964e1a05 |
ResourceName | String | 资源文件名称 |
LocalPath | String | 资源文件路径 示例值:/datast1udio/resource/1625 |
RemotePath | String | 资源对象COS存储路径 示例值:/datast1udio/resource/1 |
FileExtensionType | String | 资源文件类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:zip |
Size | String | 资源大小 示例值:1MB |
CreatorUserUin | String | 创建用户ID |
CreatorUserName | String | 创建用户名称 |
UpdateUserName | String | 最后更新用户名称 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateUserUin | String | 最后更新用户ID 注意:此字段可能返回 null,表示取不到有效值。 |
BucketName | String | COS 桶 示例值:xb-bj-13150517 |
CosRegion | String | COS 地域 示例值:ap-beijing |
ResourceSourceMode | String | 资源来源模式 示例值:UPLOAD_MODE |
BundleId | String | 本地工程ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
BundleInfo | String | 本地工程信息 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceFileItem
获取资源文件列表item
被如下接口引用:ListResourceFiles。
名称 | 类型 | 描述 |
---|---|---|
ResourceId | String | 资源文件ID 示例值:1531609696090365952 |
ResourceName | String | 资源文件名称 示例值:wedata.json |
FileExtensionType | String | 资源文件类型 示例值:zip |
LocalPath | String | 资源路径 示例值:aaaaa/qw/wedata.json |
ResourceFilePage
资源文件分页
被如下接口引用:ListResourceFiles。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of ResourceFileItem | 任务集合信息 |
TotalPageNumber | Integer | 总页数 示例值:1 |
TotalCount | Integer | 总数量 示例值:1 |
PageNumber | Integer | 当前页 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 每页显示数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
ResourceFolder
资源文件夹详情
被如下接口引用:ListResourceFolders。
名称 | 类型 | 描述 |
---|---|---|
FolderId | String | 资源文件夹ID |
CreateUserUin | String | 创建人ID |
CreateUserName | String | 创建人名称 |
FolderPath | String | 文件夹路径 |
FolderName | String | 文件夹名称 |
ResourceFolderPage
资源文件分页
被如下接口引用:ListResourceFolders。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of ResourceFolder | 资源文件夹集合信息 |
TotalPageNumber | Integer | 总页数 示例值:1 |
TotalCount | Integer | 总数量 示例值:5 |
PageNumber | Integer | 当前页 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 每页显示数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
SQLContentActionResult
SQL探索文件/文件夹操作结果
被如下接口引用:DeleteSQLFolder, DeleteSQLScript, UpdateSQLFolder。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 操作是否成功 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 |
SQLFolderNode
SQL脚本文件树节点
被如下接口引用:ListSQLFolderContents。
名称 | 类型 | 描述 |
---|---|---|
Id | String | 唯一标识 注意:此字段可能返回 null,表示取不到有效值。 |
Name | String | 名称 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 类型 folder,script 注意:此字段可能返回 null,表示取不到有效值。 |
ParentFolderPath | String | 父文件夹path,/aaa/bbb/ccc 注意:此字段可能返回 null,表示取不到有效值。 |
IsLeaf | Boolean | 是否叶子节点 注意:此字段可能返回 null,表示取不到有效值。 |
Params | String | 业务参数 注意:此字段可能返回 null,表示取不到有效值。 |
AccessScope | String | 权限范围: SHARED, PRIVATE 注意:此字段可能返回 null,表示取不到有效值。 |
Path | String | 节点路径 注意:此字段可能返回 null,表示取不到有效值。 |
CreateUserUin | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 |
NodePermission | String | 当前用户对节点拥有的权限 注意:此字段可能返回 null,表示取不到有效值。 |
Children | Array of SQLFolderNode | 子节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUin | String | 文件责任人 注意:此字段可能返回 null,表示取不到有效值。 |
SQLScript
数据探索脚本业务处理实体
被如下接口引用:CreateSQLScript, GetSQLScript, UpdateSQLScript。
名称 | 类型 | 描述 |
---|---|---|
ScriptId | String | 脚本id 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptName | String | 脚本名称 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUin | String | 脚本所有者 uin 注意:此字段可能返回 null,表示取不到有效值。 |
ParentFolderPath | String | 父文件夹path,/aaa/bbb/ccc 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptConfig | SQLScriptConfig | 脚本配置 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptContent | String | 脚本内容 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateUserUin | String | 最近一次操作人 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 更新时间 yyyy-MM-dd hh:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 yyyy-MM-dd hh:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 |
AccessScope | String | 权限范围:SHARED, PRIVATE 注意:此字段可能返回 null,表示取不到有效值。 |
Path | String | 节点全路径,/aaa/bbb/ccc.ipynb,由各个节点的名称组成 注意:此字段可能返回 null,表示取不到有效值。 |
SQLScriptConfig
数据探索脚本配置
被如下接口引用:CreateSQLScript, GetSQLScript, UpdateSQLScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatasourceId | String | 否 | 数据源Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:9584 |
DatasourceEnv | String | 否 | 数据源环境 注意:此字段可能返回 null,表示取不到有效值。 示例值:development |
ComputeResource | String | 否 | 计算资源 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
ExecutorGroupId | String | 否 | 执行资源组 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240102201245028277 |
Params | String | 否 | 高级运行参数,变量替换,map-json String,String 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"userSSL": true} |
AdvanceConfig | String | 否 | 高级设置,执行配置参数,map-json String,String. 采用Base64编码 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"ExecutorSize":"medium","ExecutorNumbers":20,"ExecutorMaxNumbers":null,"DriverSize":"small","Type":"0"} |
SQLStopResult
停止sql运行结果
被如下接口引用:StopSQLScriptRun。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 是否成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SqlCreateResult
创建数据探索脚本文件夹返回类
被如下接口引用:CreateSQLFolder。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FolderId | String | 否 | 文件夹id 注意:此字段可能返回 null,表示取不到有效值。 示例值:wer25267 |
SubmitTaskResult
提交数据开发任务结果
被如下接口引用:SubmitTask。
名称 | 类型 | 描述 |
---|---|---|
VersionId | String | 生成的任务版本ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:203437477419_243242348237 |
Status | Boolean | 提交状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Task
任务对象
被如下接口引用:GetOpsTask, GetTask, GetTaskVersion。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskBaseAttribute | TaskBaseAttribute | 是 | 任务基本属性 注意:此字段可能返回 null,表示取不到有效值。 |
TaskConfiguration | TaskConfiguration | 是 | 任务配置 注意:此字段可能返回 null,表示取不到有效值。 |
TaskSchedulerConfiguration | TaskSchedulerConfiguration | 是 | 任务调度配置 注意:此字段可能返回 null,表示取不到有效值。 |
TaskBaseAttribute
任务基本属性信息
被如下接口引用:GetOpsTask, GetTask, ListTasks。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:250814213724 |
TaskTypeId | Integer | 是 | 任务类型ID: * 21:JDBC SQL * 23:TDSQL-PostgreSQL * 26:OfflineSynchronization * 30:Python * 31:PySpark * 33:Impala * 34:Hive SQL * 35:Shell * 36:Spark SQL * 38:Shell Form Mode * 39:Spark * 40:TCHouse-P * 41:Kettle * 42:Tchouse-X * 43:TCHouse-X SQL * 46:DLC Spark * 47:TiOne * 48:Trino * 50:DLC PySpark * 92:MapReduce * 130:Branch Node * 131:Merged Node * 132:Notebook * 133:SSH * 134:StarRocks * 137:For-each * 138:Setats SQL 注意:此字段可能返回 null,表示取不到有效值。 示例值:30 |
WorkflowId | String | 是 | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:185c35d4-958e-4574-9f6c-3eca00b95870 |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:task_01 |
TaskLatestVersionNo | String | 否 | 最近一次保存版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:V1 |
TaskLatestSubmitVersionNo | String | 否 | 最近一次提交版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:V1 |
WorkflowName | String | 否 | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:wf_01 |
Status | String | 否 | 任务状态: * N: 新建 * Y: 调度中 * F: 已下线 * O: 已暂停 * T: 下线中 * INVALID: 已失效 注意:此字段可能返回 null,表示取不到有效值。 示例值:N |
Submit | Boolean | 否 | 任务最新提交状态,任务是否已经提交:true/false 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
CreateTime | String | 否 | 任务创建时间,示例:2022-02-12 11:13:41 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-02-12 11:13:41 |
LastUpdateTime | String | 否 | 最后更新时间,示例:2025-08-13 16:34:06 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-27 17:27:58 |
LastUpdateUserName | String | 否 | 最后更新人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:zhanglin |
LastOpsTime | String | 否 | 最后运维时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-27 17:27:58 |
LastOpsUserName | String | 否 | 最后运维人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:zhanglin |
OwnerUin | String | 否 | 任务负责人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028579801 |
TaskDescription | String | 否 | 任务描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:test task! |
UpdateUserUin | String | 否 | 最近一次更新用户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028579801 |
CreateUserUin | String | 否 | 创建用户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028579801 |
TaskCode
任务代码
被如下接口引用:GetOpsTaskCode。
名称 | 类型 | 描述 |
---|---|---|
CodeContent | String | 代码内容 |
CodeFileSize | Integer | 代码文件大小,单位bytes |
TaskCodeResult
任务代码
被如下接口引用:GetTaskCode。
名称 | 类型 | 描述 |
---|---|---|
CodeInfo | String | 代码内容 注意:此字段可能返回 null,表示取不到有效值。 |
CodeFileSize | String | 代码文件大小,单位KB 注意:此字段可能返回 null,表示取不到有效值。 |
TaskConfiguration
任务配置信息
被如下接口引用:GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CodeContent | String | 否 | 代码内容的Base64编码 注意:此字段可能返回 null,表示取不到有效值。 示例值:c2VsZWN0IDE= |
TaskExtConfigurationList | Array of TaskExtParameter | 否 | 任务扩展属性配置列表 注意:此字段可能返回 null,表示取不到有效值。 |
DataCluster | String | 否 | 集群ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-kvo70628 |
BrokerIp | String | 否 | 指定的运行节点 注意:此字段可能返回 null,表示取不到有效值。 示例值:any |
YarnQueue | String | 否 | 资源池队列名称,需要通过 DescribeProjectClusterQueues 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:queue |
SourceServiceId | String | 否 | 来源数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:;100647; |
SourceServiceType | String | 否 | 来源数据源类型, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:;setats; |
SourceServiceName | String | 否 | 来源数据源名称, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:;Setats_cluster-0yswvrky; |
TargetServiceId | String | 否 | 目标数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:;100648; |
TargetServiceType | String | 否 | 目标数据源类型, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:;setats; |
TargetServiceName | String | 否 | 目标数据源名称, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:;Setats_cluster-0yswvrkx; |
ResourceGroup | String | 否 | 资源组ID: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId 注意:此字段可能返回 null,表示取不到有效值。 示例值:20230112132636530791 |
ResourceGroupName | String | 否 | 资源组名称: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupName 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_rg1 |
TaskSchedulingParameterList | Array of TaskSchedulingParameter | 否 | 调度参数 注意:此字段可能返回 null,表示取不到有效值。 |
BundleId | String | 否 | Bundle使用的ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:525793f2-8425-4238-af46-c5caea381a5e |
BundleInfo | String | 否 | Bundle信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"bundleName":"bundle名称","bundlePath":"bundle路径"} |
TaskDataRegistry
任务数据库登记项
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatasourceId | String | 是 | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:9588 |
DatabaseName | String | 是 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a0a0a |
TableName | String | 是 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:baseline_features |
PartitionName | String | 是 | 分区名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
DataFlowType | String | 是 | 输入输出表类型 输入流 UPSTREAM, 输出流 DOWNSTREAM; 注意:此字段可能返回 null,表示取不到有效值。 示例值:UPSTREAM |
TablePhysicalId | String | 是 | 表物理唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1315051759-ap-beijing-null-DLC-DataLakeCatalog-a0a0a-null-baseline_features |
DbGuid | String | 否 | 库唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:250910180035 |
TableGuid | String | 否 | 表唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:250910180037 |
TaskDependDto
依赖任务信息
被如下接口引用:ListDownstreamTasks, ListUpstreamTasks。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20250918205013913 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:name |
WorkflowId | String | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 示例值:834671df-e995-43ab-86cf-8fd422a7ec3f |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:workflow_name |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1464962169590902784 |
Status | String | 任务状态: - Y: 运行 - F: 停止 - O: 冻结 - T: 停止中 - INVALID: 已失效 注意:此字段可能返回 null,表示取不到有效值。 示例值:Y |
TaskTypeId | Integer | 任务类型id 注意:此字段可能返回 null,表示取不到有效值。 示例值:35 |
TaskTypeDesc | String | 任务类型描述 - 20 : 通用数据同步 - 25 : ETLTaskType - 26 : ETLTaskType - 30 : python - 31 : pyspark - 34 : hivesql - 35 : shell - 36 : sparksql - 21 : jdbcsql - 32 : dlc - 33 : ImpalaTaskType - 40 : CDWTaskType - 41 : kettle - 42 : TCHouse-X - 43 : TCHouse-X SQL - 46 : dlcsparkTaskType - 47 : TiOneMachineLearningTaskType - 48 : Trino - 50 : DLCPyspark - 23 : TencentDistributedSQL - 39 : spark - 92 : MRTaskType - 38 : ShellScript - 70 : HiveSQLScrip - 130 : 分支 - 131 : 归并 - 132 : Notebook探索 - 133 : SSH节点 - 134 : StarRocks - 137 : For-each - 10000 : 自定义业务通用 注意:此字段可能返回 null,表示取不到有效值。 示例值:shell任务 |
ScheduleDesc | String | 调度计划展示描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:从2025年08月21日 00:00:00开始,每天00:00~23:59内,每间隔5分钟执行一次 |
StartTime | String | 任务开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-07-31 21:11:24 |
EndTime | String | 任务结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-07-31 21:11:24 |
DelayTime | Integer | 延迟时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:120 |
CycleType | String | 周期类型:默认为 D 支持的类型为 * O: 一次性 * Y: 年 * M: 月 * W: 周 * D: 天 * H: 小时 * I: 分钟 * C: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:D |
OwnerUin | String | 负责人 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028578763 |
TaskAction | String | 弹性周期配置 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
InitStrategy | String | 调度初始化策略 注意:此字段可能返回 null,表示取不到有效值。 示例值:T+1 |
CrontabExpression | String | crontab表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 0 0 0 1 0 |
TaskExtParameter
任务扩展信息参数
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 注意:此字段可能返回 null,表示取不到有效值。 示例值:extraInfo |
ParamValue | String | 是 | 参数值 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"fromMapping":false} |
TaskInstance
调度任务实例实体
被如下接口引用:ListDownstreamTaskInstances, ListTaskInstances, ListUpstreamTaskInstances。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | String | 所属项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:2763518183736183934 |
InstanceKey | String | 实例唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240627201611119_2025-03-20 00:00:00 |
FolderId | String | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:f7418cc8-84f8**** |
FolderName | String | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:testFolder |
WorkflowId | String | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:ba48d170-3239*** |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:cron_test_wf |
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240627201611119 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:cron_test |
CurRunDate | String | 实例数据时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:00 |
InstanceState | String | 实例状态 - WAIT_EVENT: 等待事件 - WAIT_UPSTREAM: 等待上游 - WAIT_RUN: 等待运行 - RUNNING: 运行中 - SKIP_RUNNING: 跳过运行 - FAILED_RETRY: 失败重试 - EXPIRED: 失败 - COMPLETED: 成功 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceType | Integer | 实例类型 - 0 表示补录类型 - 1 表示周期实例 - 2 表示非周期实例 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OwnerUinList | Array of String | 负责人列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalRunNum | Integer | 累计运行次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskType | String | 任务类型描述 |
TaskTypeId | Integer | 任务类型id 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 任务周期类型 支持过滤多个,条件间为 或 的过滤关系 * O: ONEOFF_CYCLE * Y: YEAR_CYCLE * M: MONTH_CYCLE * W: WEEK_CYCLE * D: DAY_CYCLE * H: HOUR_CYCLE * I: MINUTE_CYCLE * C: CRONTAB_CYCLE 注意:此字段可能返回 null,表示取不到有效值。 |
TryLimit | Integer | 每次运行失败,下发重试次数限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
Tries | Integer | 失败重试次数 再次使用 手动重跑 或 补录实例等方式触发运行时,会被重置为 0 后重新计数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StartTime | String | 运行开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:01 |
EndTime | String | 运行完成时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:11 |
CostTime | Integer | 耗费时间, 单位ms 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
SchedulerTime | String | 计划调度时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:00 |
LastUpdateTime | String | 实例最近更新时间, 时间格式为 yyyy-MM-dd HH:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-19 00:00:00 |
ExecutorGroupId | String | 执行资源组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240821154428723333 |
ExecutorGroupName | String | 资源组名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试资源组 |
TaskInstanceDetail
调度任务实例详情
被如下接口引用:GetTaskInstance。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | String | 所属项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:2763518183736183934 |
InstanceKey | String | 实例唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240627201611119_2025 |
FolderId | String | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:f7418cc8-84f8**** |
FolderName | String | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:testFolder |
WorkflowId | String | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:ba48d170-3239*** |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:cron_test_wf |
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240627201611119 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:cron_test |
TaskTypeId | Integer | taskType对应的id 示例值:32 |
TaskType | String | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:SHELL |
CycleType | String | 任务周期类型 * ONEOFF_CYCLE: 一次性 * YEAR_CYCLE: 年 * MONTH_CYCLE: 月 * WEEK_CYCLE: 周 * DAY_CYCLE: 天 * HOUR_CYCLE: 小时 * MINUTE_CYCLE: 分钟 * CRONTAB_CYCLE: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:YEAR_CYCLE |
CurRunDate | String | 实例数据时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:00 |
InstanceState | String | 实例状态 - WAIT_EVENT: 等待事件 - WAIT_UPSTREAM: 等待上游 - WAIT_RUN: 等待运行 - RUNNING: 运行中 - SKIP_RUNNING: 跳过运行 - FAILED_RETRY: 失败重试 - EXPIRED: 失败 - COMPLETED: 成功 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceType | Integer | 实例类型 - 0 表示补录类型 - 1 表示周期实例 - 2 表示非周期实例 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OwnerUinList | Array of String | 负责人列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalRunNum | Integer | 累计运行次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TryLimit | Integer | 每次运行失败,下发重试次数限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
Tries | Integer | 失败重试次数 再次使用 手动重跑 或 补录实例等方式触发运行时,会被重置为 0 后重新计数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CostTime | Integer | 耗费时间, 单位ms 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
StartTime | String | 运行开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:01 |
EndTime | String | 运行完成时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:11 |
SchedulerTime | String | 计划调度时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-20 00:00:00 |
LastUpdateTime | String | 实例最近更新时间, 时间格式为 yyyy-MM-dd HH:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-19 00:00:00 |
ExecutorGroupId | String | 执行资源组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20240821154428723333 |
ExecutorGroupName | String | 资源组名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试资源组 |
JobErrorMsg | String | 简要的任务失败信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:用户代码和执行环境存在异常 |
TaskInstanceExecutions
任务实例执行列表
被如下接口引用:ListTaskInstanceExecutions。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 结果总数 |
TotalPageNumber | Integer | 总页数 |
Items | Array of InstanceExecution | 记录列表 |
PageNumber | Integer | 页码 |
PageSize | Integer | 分页大小 |
TaskInstancePage
实例列表分页实体
被如下接口引用:ListDownstreamTaskInstances, ListTaskInstances, ListUpstreamTaskInstances。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
TotalPageNumber | Integer | 总分页数 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 每页条目数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of TaskInstance | 数据列表 注意:此字段可能返回 null,表示取不到有效值。 |
TaskOpsInfo
任务运维工作流列表详情
被如下接口引用:ListOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 示例值:20250725151016827 |
TaskName | String | 任务名 示例值:test_task |
OwnerUin | String | 负责人Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028448913 |
Status | String | 任务状态: - Y: 调度中 - F: 已下线 - O: 已暂停 - T: 下线中 - INVALID: 已失效 示例值:N |
FolderId | String | 文件夹id 示例值:e0609ae9-2ab8-4ffe-b46b-95e4352df281 |
FolderName | String | 文件夹名字 示例值:test_folder |
WorkflowId | String | 工作流id 示例值:a091bc68-cfcc-4c78-b6c0-c34dd0173d22 |
WorkflowName | String | 工作流名称 示例值:test_work_flow_name |
ProjectId | String | 项目id 示例值:1460947878144537296 |
ProjectName | String | 项目名称 示例值:调度demo项目 |
UpdateUserUin | String | 更新人名称 示例值:100036013191 |
TaskTypeId | Integer | 任务类型Id: * 21:JDBC SQL * 23:TDSQL-PostgreSQL * 26:OfflineSynchronization * 30:Python * 31:PySpark * 33:Impala * 34:Hive SQL * 35:Shell * 36:Spark SQL * 38:Shell Form Mode * 39:Spark * 40:TCHouse-P * 41:Kettle * 42:Tchouse-X * 43:TCHouse-X SQL * 46:DLC Spark * 47:TiOne * 48:Trino * 50:DLC PySpark * 92:MapReduce * 130:Branch Node * 131:Merged Node * 132:Notebook * 133:SSH * 134:StarRocks * 137:For-each * 138:Setats SQL 示例值:26 |
TaskTypeDesc | String | 任务类型描述 - 通用数据同步 - ETLTaskType - ETLTaskType - python - pyspark - HiveSQLTaskType - shell - SparkSQLTaskType - JDBCSQLTaskType - DLCTaskType - ImpalaTaskType - CDWTaskType - kettle - DLCSparkTaskType - TiOne机器学习 - TrinoTaskType - DLCPyspark - spark - mr - shell脚本 - hivesql脚本 - 自定义业务通用 注意:此字段可能返回 null,表示取不到有效值。 示例值:Shell |
CycleType | String | 任务周期类型 * ONEOFF_CYCLE: 一次性 * YEAR_CYCLE: 年 * MONTH_CYCLE: 月 * WEEK_CYCLE: 周 * DAY_CYCLE: 天 * HOUR_CYCLE: 小时 * MINUTE_CYCLE: 分钟 * CRONTAB_CYCLE: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:DAY_CYCLE |
ExecutorGroupId | String | 资源组id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20230302191306287347 |
ScheduleDesc | String | 调度描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:从2024年06月18日 00:00:00开始,每天00:00~23:59内,每间隔5分钟执行一次 |
ExecutorGroupName | String | 资源组名称 示例值:集成资源组-test |
LastSchedulerCommitTime | String | 最新调度提交时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-07-25 15:10:28 |
FirstRunTime | String | 首次执行时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-04-17 00:00:00 |
FirstSubmitTime | String | 最近一次提交时间 示例值:2024-07-11 23:51:23 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-07-25 15:10:19 |
LastUpdateTime | String | 最近更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-07-11 23:51:23 |
TaskSchedulerConfiguration
任务调度配置信息
被如下接口引用:GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CycleType | String | 否 | 周期类型:支持的类型为 ONEOFF_CYCLE: 一次性 YEAR_CYCLE: 年 MONTH_CYCLE: 月 WEEK_CYCLE: 周 DAY_CYCLE: 天 HOUR_CYCLE: 小时 MINUTE_CYCLE: 分钟 CRONTAB_CYCLE: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:DAY_CYCLE |
ScheduleTimeZone | String | 否 | 时区 注意:此字段可能返回 null,表示取不到有效值。 示例值:UTC+8 |
CrontabExpression | String | 否 | 0 2 3 1,L,2 * ? 注意:此字段可能返回 null,表示取不到有效值。 示例值:Cron表达式 |
StartTime | String | 否 | 生效日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-07-30 00:00:00 |
EndTime | String | 否 | 结束日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2099-12-31 23:59:59 |
ExecutionStartTime | String | 否 | 执行时间 左闭区间 注意:此字段可能返回 null,表示取不到有效值。 示例值:00:00 |
ExecutionEndTime | String | 否 | 执行时间 右闭区间 注意:此字段可能返回 null,表示取不到有效值。 示例值:23:59 |
ScheduleRunType | Integer | 否 | 调度类型: 0 正常调度 1 空跑调度 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
CalendarOpen | String | 否 | 日历调度 取值为 0 和 1, 1为打开,0为关闭,默认为0 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
CalendarId | String | 否 | 日历调度 日历 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:720 |
CalendarName | String | 否 | 日历调度 日历名称, 需要从 DescribeScheduleCalendarPageList 中获取 注意:此字段可能返回 null,表示取不到有效值。 示例值:交易所日历 |
SelfDepend | String | 否 | 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序) 注意:此字段可能返回 null,表示取不到有效值。 示例值:serial |
UpstreamDependencyConfigList | Array of DependencyTaskBrief | 否 | 上游依赖数组 注意:此字段可能返回 null,表示取不到有效值。 |
DownStreamDependencyConfigList | Array of DependencyTaskBrief | 否 | 下游依赖数组 注意:此字段可能返回 null,表示取不到有效值。 |
EventListenerList | Array of EventListener | 否 | 事件数组 注意:此字段可能返回 null,表示取不到有效值。 |
RunPriority | Integer | 否 | 任务调度优先级 运行优先级 4高 5中 6低 , 默认:6 注意:此字段可能返回 null,表示取不到有效值。 示例值:6 |
RetryWait | Integer | 否 | 重试策略 重试等待时间,单位分钟: 默认: 5 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
MaxRetryAttempts | Integer | 否 | 重试策略 最大尝试次数, 默认: 4 注意:此字段可能返回 null,表示取不到有效值。 示例值:4 |
ExecutionTTL | Integer | 否 | 超时处理策略 运行耗时超时(单位:分钟)默认为 -1 注意:此字段可能返回 null,表示取不到有效值。 示例值:-1 |
WaitExecutionTotalTTL | String | 否 | 超时处理策略 等待总时长耗时超时(单位:分钟)默认为 -1 注意:此字段可能返回 null,表示取不到有效值。 示例值:-1 |
AllowRedoType | String | 否 | 重跑&补录配置, 默认为 ALL; , ALL 运行成功或失败后皆可重跑或补录, FAILURE 运行成功后不可重跑或补录,运行失败后可重跑或补录, NONE 运行成功或失败后皆不可重跑或补录; 注意:此字段可能返回 null,表示取不到有效值。 示例值:ALL |
ParamTaskOutList | Array of OutTaskParameter | 否 | 输出参数数组 注意:此字段可能返回 null,表示取不到有效值。 |
ParamTaskInList | Array of InTaskParameter | 否 | 输入参数数组 注意:此字段可能返回 null,表示取不到有效值。 |
TaskOutputRegistryList | Array of TaskDataRegistry | 否 | 产出登记 注意:此字段可能返回 null,表示取不到有效值。 |
InitStrategy | String | 否 | 实例生成策略 * T_PLUS_0: T+0生成,默认策略 * T_PLUS_1: T+1生成 注意:此字段可能返回 null,表示取不到有效值。 示例值:T_PLUS_0 |
TaskSchedulingParameter
任务调度变量参数
被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 注意:此字段可能返回 null,表示取不到有效值。 示例值:q |
ParamValue | String | 是 | 参数值 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
TaskVersion
任务版本列表信息
被如下接口引用:ListTaskVersions。
名称 | 类型 | 描述 |
---|---|---|
CreateTime | String | 保存时间 注意:此字段可能返回 null,表示取不到有效值。 |
VersionNum | String | 版本号 注意:此字段可能返回 null,表示取不到有效值。 |
CreateUserUin | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 |
VersionId | String | 保存版本id 注意:此字段可能返回 null,表示取不到有效值。 |
VersionRemark | String | 版本描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
ApproveStatus | String | 审批状态(只有提交版本有) 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 生产状态(只有提交版本有) 注意:此字段可能返回 null,表示取不到有效值。 |
ApproveUserUin | String | 审批人(只有提交版本有) 注意:此字段可能返回 null,表示取不到有效值。 |
TaskVersionDetail
任务版本列表信息
被如下接口引用:GetTaskVersion。
名称 | 类型 | 描述 |
---|---|---|
CreateTime | String | 保存时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-26 15:28:52 |
VersionNum | String | 版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:V30 |
CreateUserUin | String | 版本创建人 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028578753 |
VersionId | String | 保存版本Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20250723102549746_20250826152851866 |
VersionRemark | String | 版本描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
ApproveStatus | String | 审批状态(只有提交版本有) 注意:此字段可能返回 null,表示取不到有效值。 示例值:REJECT |
ApproveTime | String | 生产状态(只有提交版本有) 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-08-26 15:28:52 |
Task | Task | 版本的任务详情 注意:此字段可能返回 null,表示取不到有效值。 |
ApproveUserUin | String | 审批人Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028578753 |
TimeOutStrategyInfo
告警超时配置规则信息
被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, UpdateOpsAlarmRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleType | Integer | 否 | 超时告警超时配置: 1.预计运行耗时超时,2.预计完成时间超时,3.预计等待调度耗时超时,4.预计周期内完成但实际未完成 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Type | Integer | 否 | 超时值配置类型 1--指定值 2--平均值 注意:此字段可能返回 null,表示取不到有效值。 |
Hour | Integer | 否 | 超时指定值小时, 默认 为0 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Min | Integer | 否 | 超时指定值分钟, 默认为1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ScheduleTimeZone | String | 否 | 超时时间对应的时区配置, 如 UTC+7, 默认为UTC+8 注意:此字段可能返回 null,表示取不到有效值。 示例值:UTC+7 |
UpdateFolderResult
更新文件夹结果
被如下接口引用:UpdateResourceFolder, UpdateWorkflowFolder。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 更新状态,true表示更新成功,false表示更新失败 |
UpdateResourceFileResult
更新资源文件结果
被如下接口引用:UpdateResourceFile。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | true |
UpdateTaskBaseAttribute
更新任务基本属性信息
被如下接口引用:UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskName | String | 是 | 任务名称 示例值:sh_241204_111248 |
OwnerUin | String | 是 | 任务负责人ID 示例值:100028579801 |
TaskDescription | String | 是 | 任务描述 示例值:this is a task |
UpdateTaskBrief
更新任务对象入参
被如下接口引用:UpdateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskBaseAttribute | UpdateTaskBaseAttribute | 是 | 任务基本属性 |
TaskConfiguration | TaskConfiguration | 是 | 任务配置 |
TaskSchedulerConfiguration | TaskSchedulerConfiguration | 是 | 任务调度配置 |
UpdateTaskResult
更新任务返回体
被如下接口引用:UpdateTask。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 处理结果,成功返回 true,不成功返回 false 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
UpdateTasksOwner
批量修改任务负责人结果
被如下接口引用:UpdateOpsTasksOwner。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 修改任务责任人结果 示例值:true |
UpdateWorkflowResult
更新工作流结果
被如下接口引用:UpdateWorkflow。
名称 | 类型 | 描述 |
---|---|---|
Status | Boolean | 更新工作流结果 示例值:true |
WorkflowDetail
查询工作流详细信息
被如下接口引用:GetWorkflow。
名称 | 类型 | 描述 |
---|---|---|
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:hour_to_一次性 |
OwnerUin | String | 责任人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:100029705957 |
CreateUserUin | String | 创建人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:100029705957 |
WorkflowType | String | 工作流类型,cycle和manual 注意:此字段可能返回 null,表示取不到有效值。 示例值:cycle |
WorkflowParams | Array of ParamInfo | 工作流参数数组 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowSchedulerConfiguration | WorkflowSchedulerConfiguration | 统一调度参数 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowDesc | String | 工作流描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:描述信息 |
Path | String | 工作流所属路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/keyl_p0_test/hour_to_一次性 |
BundleId | String | BundleId项 注意:此字段可能返回 null,表示取不到有效值。 示例值:be4b6673-96da-4402-beae-a89dbc4d627b |
BundleInfo | String | BundleInfo项 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"aaa":"bbb"} |
WorkflowFolder
文件夹信息
被如下接口引用:ListWorkflowFolders。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | String | 项目ID |
FolderId | String | 文件夹ID |
FolderPath | String | 文件夹绝对路径 |
CreateUserUin | String | 创建人ID 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowFolderPage
资源文件分页
被如下接口引用:ListWorkflowFolders。
名称 | 类型 | 描述 |
---|---|---|
PageNumber | Integer | 数据页数,大于等于1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 每页显示的数据条数,最小为10条,最大为200 条 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalCount | Integer | 文件夹总数 示例值:5 |
TotalPageNumber | Integer | 总页数 示例值:2 |
Items | Array of WorkflowFolder | 文件夹列表 |
WorkflowInfo
获取工作流的列表信息item
被如下接口引用:ListWorkflows。
名称 | 类型 | 描述 |
---|---|---|
WorkflowId | String | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:135 |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:135 |
WorkflowType | String | 工作流类型,cycle及manual 注意:此字段可能返回 null,表示取不到有效值。 示例值:cycle |
OwnerUin | String | 负责人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:135 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-09-22 17:03:05 |
ModifyTime | String | 最新修改时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-09-25 17:03:05 |
UpdateUserUin | String | 最后更新人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:135 |
WorkflowDesc | String | 工作流描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:v1 |
CreateUserUin | String | 创建人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:135 |
WorkflowSchedulerConfiguration
工作流统一调度出参
被如下接口引用:GetWorkflow。
名称 | 类型 | 描述 |
---|---|---|
ScheduleTimeZone | String | 时区 注意:此字段可能返回 null,表示取不到有效值。 示例值:UTC+8 |
CycleType | String | 周期类型:支持的类型为 ONEOFF_CYCLE: 一次性 YEAR_CYCLE: 年 MONTH_CYCLE: 月 WEEK_CYCLE: 周 DAY_CYCLE: 天 HOUR_CYCLE: 小时 MINUTE_CYCLE: 分钟 CRONTAB_CYCLE: crontab表达式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:HOUR_CYCLE |
SelfDepend | String | 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序) 注意:此字段可能返回 null,表示取不到有效值。 示例值:serial |
StartTime | String | 生效开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-09-11 00:00:00 |
EndTime | String | 生效结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2099-12-31 23:59:59 |
DependencyWorkflow | String | 工作流依赖,yes or no 注意:此字段可能返回 null,表示取不到有效值。 示例值:no |
ExecutionStartTime | String | 执行时间左闭区间,示例:00:00 注意:此字段可能返回 null,表示取不到有效值。 示例值:00:00 |
ExecutionEndTime | String | 执行时间右闭区间,示例:23:59 注意:此字段可能返回 null,表示取不到有效值。 示例值:23:59 |
CrontabExpression | String | cron表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 0 0 * * ? |
CalendarOpen | String | 是否开启日历调度 1 开启 0关闭 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CalendarName | String | 日历名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:交易所日历 |
CalendarId | String | 日历id 注意:此字段可能返回 null,表示取不到有效值。 示例值:105 |
WorkflowSchedulerConfigurationInfo
工作流统一调度参数入参
依赖任务信息
取值说明表:
当前任务周期类型 | 上游任务周期类型 | 配置方式 | MainCyclicConfig取值 | 时间维度/实例范围 | SubordinateCyclicConfig取值 | offset取值 |
---|---|---|---|---|---|---|
HOUR_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
MINUTE_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
DAY_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
DAY_CYCLE | WEEK_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
HOUR_CYCLE | HOUR_CYCLE | 推荐策略 | HOUR | 按小时/最近实例 | CURRENT_HOUR | 无 |
HOUR_CYCLE | HOUR_CYCLE | 推荐策略 | HOUR | 按小时/前一周期 | PREVIOUS_HOUR_CYCLE | 无 |
HOUR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/上周 | PREVIOUS_WEEK | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/上周五 | PREVIOUS_FRIDAY | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/上周日 | PREVIOUS_WEEKEND | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 、 | CURRENT_DAY | 无 |
WEEK_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
WEEK_CYCLE | ONEOFF_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
HOUR_CYCLE | MINUTE_CYCLE | 推荐策略 | HOUR | 按小时/前一个小时(-60,0] | PREVIOUS_HOUR_LATER_OFFSET_MINUTE | 无 |
HOUR_CYCLE | MINUTE_CYCLE | 推荐策略 | HOUR | 按小时/前一个小时 | PREVIOUS_HOUR | 无 |
HOUR_CYCLE | MINUTE_CYCLE | 推荐策略 | HOUR | 按小时/当前小时 | CURRENT_HOUR | 无 |
YEAR_CYCLE | WEEK_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
WEEK_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
MINUTE_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
WEEK_CYCLE | HOUR_CYCLE | 推荐策略 | WEEK | 按周/上周 | PREVIOUS_WEEK | 无 |
WEEK_CYCLE | HOUR_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
MINUTE_CYCLE | HOUR_CYCLE | 推荐策略 | HOUR | 按小时/当前小时 | CURRENT_HOUR | 无 |
HOUR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | HOUR_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | HOUR_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | ONEOFF_CYCLE | 推荐策略 | MONTH | 按月/当月 | CURRENT_MONTH | 无 |
DAY_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
DAY_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
MONTH_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
ONEOFF_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
MINUTE_CYCLE | MINUTE_CYCLE | 推荐策略 | MINUTE | 按分钟/当前分钟 | CURRENT_MINUTE | 无 |
MINUTE_CYCLE | MINUTE_CYCLE | 推荐策略 | MINUTE | 按分钟/前一周期 | PREVIOUS_MINUTE_CYCLE | 无 |
YEAR_CYCLE | MINUTE_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
ONEOFF_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
DAY_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/前一天(-24 * 60,0] | PREVIOUS_DAY_LATER_OFFSET_MINUTE | 无 |
DAY_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
DAY_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
MINUTE_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
WEEK_CYCLE | WEEK_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | YEAR_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
YEAR_CYCLE | HOUR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
MINUTE_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
ONEOFF_CYCLE | MINUTE_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
HOUR_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | MINUTE_CYCLE | 推荐策略 | WEEK | 按周/上周 | PREVIOUS_WEEK | 无 |
WEEK_CYCLE | MINUTE_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
DAY_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/前一天(-24,0] | PREVIOUS_DAY_LATER_OFFSET_HOUR | 无 |
DAY_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/前一天[-24,0) | PREVIOUS_DAY | 无 |
DAY_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本年所有月 | ALL_MONTH_OF_YEAR | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/上月末 | PREVIOUS_END_OF_MONTH | 无 |
YEAR_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/上月初 | PREVIOUS_BEGIN_OF_MONTH | 无 |
ONEOFF_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
DAY_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
ONEOFF_CYCLE | HOUR_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
DAY_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
MINUTE_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
WEEK_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
WEEK_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
YEAR_CYCLE | ONEOFF_CYCLE | 推荐策略 | YEAR | 按年/当年 | CURRENT_YEAR | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | MONTH | 按月/上月末 | PREVIOUS_END_OF_MONTH | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
MONTH_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
YEAR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/本年所有天 | ALL_DAY_OF_YEAR | 无 |
YEAR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
YEAR_CYCLE | DAY_CYCLE | 推荐策略 | DAY | 按天/前一天 | PREVIOUS_DAY | 无 |
HOUR_CYCLE | WEEK_CYCLE | 推荐策略 | WEEK | 按周/本周 | CURRENT_WEEK | 无 |
MONTH_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/当月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | MONTH_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
MONTH_CYCLE | MINUTE_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | MINUTE_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | WEEK_CYCLE | 推荐策略 | MONTH | 按月/上月 | PREVIOUS_MONTH | 无 |
MONTH_CYCLE | WEEK_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
MONTH_CYCLE | WEEK_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
DAY_CYCLE | YEAR_CYCLE | 推荐策略 | YEAR | 按年/本年 | CURRENT_YEAR | 无 |
DAY_CYCLE | YEAR_CYCLE | 推荐策略 | DAY | 按天/最近一次数据时间的实例 | RECENT_DATE | 无 |
ONEOFF_CYCLE | ONEOFF_CYCLE | 推荐策略 | DAY | 按天/当天 | CURRENT_DAY | 无 |
ONEOFF_CYCLE | MONTH_CYCLE | 推荐策略 | MONTH | 按月/本月 | CURRENT_MONTH | 无 |
CRONTAB_CYCLE | CRONTAB_CYCLE | 推荐策略 | CRONTAB | 无 | CURRENT | 无 |
HOUR_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | HOUR_CYCLE | 自定义 | RANGE_HOUR | 区间(小时) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | DAY_CYCLE | 自定义 | RANGE_DAY | 区间(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | MINUTE_CYCLE | 自定义 | RANGE_MINUTE | 区间(分钟) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
HOUR_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
MINUTE_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
WEEK_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | HOUR_CYCLE | 自定义 | LIST_HOUR | 列表(小时) | 无 | 逗号分隔的整数,如-1,0 |
DAY_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
YEAR_CYCLE | DAY_CYCLE | 自定义 | LIST_DAY | 列表(天) | 无 | 逗号分隔的整数,如-1,0 |
MONTH_CYCLE | MINUTE_CYCLE | 自定义 | LIST_MINUTE | 列表(分钟) | 无 | 逗号分隔的整数,如-1,0 |
被如下接口引用:CreateWorkflow, UpdateWorkflow。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ScheduleTimeZone | String | 是 | 时区 示例值:UTC+8 |
CycleType | String | 是 | 周期类型:支持的类型为 ONEOFF_CYCLE: 一次性 YEAR_CYCLE: 年 MONTH_CYCLE: 月 WEEK_CYCLE: 周 DAY_CYCLE: 天 HOUR_CYCLE: 小时 MINUTE_CYCLE: 分钟 CRONTAB_CYCLE: crontab表达式类型 示例值:HOUR_CYCLE |
SelfDepend | String | 是 | 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序) 示例值:serial |
StartTime | String | 是 | 生效开始时间 示例值:2025-09-04 16:00:17 |
EndTime | String | 是 | 生效结束时间 示例值:2099-12-31 23:59:59 |
CrontabExpression | String | 是 | cron表达式 示例值:0 0 0 * * ? |
DependencyWorkflow | String | 否 | 工作流依赖,yes or no 示例值:no |
ModifyCycleValue | String | 否 | 0:不修改 1:将任务的上游依赖配置改为默认值 示例值:1 |
ClearLink | Boolean | 否 | 工作流存在跨工作流依赖且使用cron表达式调度。如果保存统一调度,会断开不支持的依赖关系 示例值:true |
MainCyclicConfig | String | 否 | ModifyCycleValue为1的时候生效,表示默认修改的上游依赖-时间维度,取值为: * CRONTAB * DAY * HOUR * LIST_DAY * LIST_HOUR * LIST_MINUTE * MINUTE * MONTH * RANGE_DAY * RANGE_HOUR * RANGE_MINUTE * WEEK * YEAR https://capi.woa.com/object/detail?product=wedata&env=api_dev&version=2025-08-06&name=WorkflowSchedulerConfigurationInfo 示例值:HOUR |
SubordinateCyclicConfig | String | 否 | ModifyCycleValue为1的时候生效,表示默认修改的上游依赖-实例范围 取值为: * ALL_DAY_OF_YEAR * ALL_MONTH_OF_YEAR * CURRENT * CURRENT_DAY * CURRENT_HOUR * CURRENT_MINUTE * CURRENT_MONTH * CURRENT_WEEK * CURRENT_YEAR * PREVIOUS_BEGIN_OF_MONTH * PREVIOUS_DAY * PREVIOUS_DAY_LATER_OFFSET_HOUR * PREVIOUS_DAY_LATER_OFFSET_MINUTE * PREVIOUS_END_OF_MONTH * PREVIOUS_FRIDAY * PREVIOUS_HOUR * PREVIOUS_HOUR_CYCLE * PREVIOUS_HOUR_LATER_OFFSET_MINUTE * PREVIOUS_MINUTE_CYCLE * PREVIOUS_MONTH * PREVIOUS_WEEK * PREVIOUS_WEEKEND * RECENT_DATE https://capi.woa.com/object/detail?product=wedata&env=api_dev&version=2025-08-06&name=WorkflowSchedulerConfigurationInfo 示例值:CURRENT_HOUR |
ExecutionStartTime | String | 否 | 执行时间左闭区间,示例:00:00,只有周期类型为MINUTE_CYCLE才需要填入 示例值:00:00 |
ExecutionEndTime | String | 否 | 执行时间右闭区间,示例:23:59,只有周期类型为MINUTE_CYCLE才需要填入 示例值:23:59 |
CalendarOpen | String | 否 | 是否开启日历调度 1 开启 0关闭 示例值:1 |
CalendarId | String | 否 | 日历id 示例值:105 |