帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-09-14 01:46:22
我的收藏

AdvancedDependencyConfig

高级依赖配置

被如下接口引用:CreateWorkflow, ListWorkflowTaskRuns, ListWorkflows, UpdateWorkflow。

名称 类型 必选 描述
Operator String 逻辑运算符号OR / AND
注意:此字段可能返回 null,表示取不到有效值。
示例值:AND
Conditions Array of TaskRunConditionRule 任务运行条件规则列表
注意:此字段可能返回 null,表示取不到有效值。

AdvancedParameter

高级运行参数(工作流高级运行时用户填入的参数)

被如下接口引用:GetWorkflowRun, ListWorkflowRuns。

名称 类型 必选 描述
ParamKey String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1
ParamValue String 参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:value1

AlarmBrief

告警配置

被如下接口引用:CreateWorkflow, GetWorkflow, UpdateWorkflow。

名称 类型 必选 描述
AlarmId String 告警 ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
AlarmMonitorType String 告警的监控对象类型,如工作流、任务等,当前支持 1. WORKFLOW 2. TASK
注意:此字段可能返回 null,表示取不到有效值。
示例值:WORKFLOW
AlarmGroups Array of AlarmGroup 告警组,最多 50 个
注意:此字段可能返回 null,表示取不到有效值。
DoNotDisturbWhenSkipped Boolean 被跳过时免打扰,默认值 false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DoNotDisturbWhenManuallyTerminated Boolean 被手动终止时免打扰,默认值 false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DoNotDisturbUntilTheLastRetry Boolean 最后一次重试前免打扰,默认值 false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

AlarmGroup

告警组

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
ChannelId String 通知渠道ID,可通过基础平台通知渠道相关接口获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ChannelName String 通知渠道名称,可以是用户组名称或邮箱地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
IsEmailChannel Boolean 是否启用邮件渠道,默认值:false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
AlarmConditions Array of String 一组告警条件,有 启动,成功,失败和任务超时告警
注意:此字段可能返回 null,表示取不到有效值。
示例值:["demo"]
ChannelType Integer 通知渠道类型。取值:0 未指定,1 Email,2 Webhook,3 Teams,4 Slack
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

AsyncActionRsp

批量异步操作的逐项结果

被如下接口引用:KillWorkflowRun, RerunWorkflowRun, RunWorkflow。

名称 类型 必选 描述
ActionResults Array of RunActionBrief 多个操作项的结果列表
注意:此字段可能返回 null,表示取不到有效值。

AsyncOperation

OneFlow 透传的 Workspace 异步文件操作信息;作业状态由 Workspace 持久化和维护

被如下接口引用:CreateFile, GetFile, UpdateFile。

名称 类型 必选 描述
IsAsync Boolean 是否异步执行;ZIP 解压创建时为 true
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
JobId String Workspace 持久化的异步作业 ID,用于查询作业进度
注意:此字段可能返回 null,表示取不到有效值。
示例值:17676143448574812
OperationId String 调用方生成的提交幂等与链路追踪标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:550e8400-e29b-41d4-a716-446655440000
Status Integer 异步作业状态:0-未指定,1-已受理,2-解压中,3-回调处理中,4-成功,5-部分失败,6-失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

CreateWorkflowRsp

CreateWorkflowRsp

被如下接口引用:CreateWorkflow。

名称 类型 必选 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76

DeleteFileResult

文件删除结果

被如下接口引用:DeleteFile。

名称 类型 必选 描述
FileId String

被删除的文件 ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:872597305364471808
Status Boolean

删除是否成功


注意:此字段可能返回 null,表示取不到有效值。
示例值:true

DeleteWorkflowRsp

DeleteWorkflowRsp

被如下接口引用:DeleteWorkflow。

名称 类型 必选 描述
Status Boolean 删除状态,true 表示成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

DependOnBrief

任务依赖简要信息

被如下接口引用:CreateWorkflow, ListWorkflows, UpdateWorkflow。

名称 类型 必选 描述
TaskId String 任务ID,可通过 ListWorkflowTasks 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo

FileConfig

文件运行配置

被如下接口引用:CreateFile, GetFile, UpdateFile。

名称 类型 必选 描述
Params String

高级运行参数,变量替换用,map-json String,String


注意:此字段可能返回 null,表示取不到有效值。
示例值:eyJtbGZsb3dfcHJlX2V4ZWN1dGVfY29zX3BhdGgiOiJodHRwczovL2J1Y2tldC0zMC0yNTE0MzYxOTEuY29zLmFwLWd1YW5nemhvdS5teXFjbG91ZC5jb20vc2NpLzE3Njc2OTIwMTg4Mjc2NzMzL3BlcnNvbmFsLzcwMDAwMjE2NDYxOC84NzI1OTczMDUzNjQ0NzE4MDgvbm90ZWJvb2tfcHJlbG9hZF9zY3JpcHQucHkifQ==
ResourceId String

执行资源 ID。来源:ListComputeResources 接口返回的 ResourceId


注意:此字段可能返回 null,表示取不到有效值。
示例值:res-1a2b3c4d
DefaultCatalog String

默认 catalog


注意:此字段可能返回 null,表示取不到有效值。
示例值:my_catalog
DefaultSchema String

默认 schema


注意:此字段可能返回 null,表示取不到有效值。
示例值:my_schema
AdvanceConfig String

高级配置,JSON 字符串


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"executorMemorySizeG":8}
ExtraParams String

扩展参数,JSON 字符串


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"timezone":"UTC+8"}
Widgets String

Notebook 交互控件定义,JSON 字符串


注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"type":"text","key":"date_var","defaultValue":"2025-01-01"}]
OutputConf Array of FileOutputConf

各单元格输出配置。仅 Get 出参返回,入参忽略

SqlSyntax String

SQL脚本语法标记


注意:此字段可能返回 null,表示取不到有效值。
示例值:DORIS_SQL
ClusterId String

平台集群id


注意:此字段可能返回 null,表示取不到有效值。
示例值:res-0473a6c4

FileInfo

文件详情

被如下接口引用:CreateFile, GetFile, UpdateFile。

名称 类型 必选 描述
AppId String

主账号 AppId


注意:此字段可能返回 null,表示取不到有效值。
示例值:260073493
WorkspaceId String

工作空间 ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:17678671667189298
FileId String

文件 ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:877933568036945920
FileName String

文件名,含后缀


注意:此字段可能返回 null,表示取不到有效值。
示例值:vv1.ipynb
FileType String

文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType


注意:此字段可能返回 null,表示取不到有效值。
示例值:NOTEBOOK_FILE
Path String

文件在工作空间中的完整路径,以 / 开头,如 /etl/daily/demo.ipynb


注意:此字段可能返回 null,表示取不到有效值。
示例值:/Workspace/0dengboxu/vv1.ipynb
FileConfig FileConfig

文件运行配置

BundleId String

绑定的 BundleId


注意:此字段可能返回 null,表示取不到有效值。
示例值:create_test
BundleInfo String

绑定的 BundleInfo,JSON 字符串


注意:此字段可能返回 null,表示取不到有效值。
示例值:{'key1': 'value1'}
Status String

文件状态。active=正常,deleted=已删除


注意:此字段可能返回 null,表示取不到有效值。
示例值:active
OwnerUserName String

文件负责人用户名


注意:此字段可能返回 null,表示取不到有效值。
示例值:wedata30-test1@tencent.com
CreateUserUin String

创建人子账号 Uin


注意:此字段可能返回 null,表示取不到有效值。
示例值:700002164619
UpdateUserUin String

最近更新人子账号 Uin


注意:此字段可能返回 null,表示取不到有效值。
示例值:700002164619
CreateTime String

创建时间,毫秒级时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1787123674
UpdateTime String

最近更新时间,毫秒级时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1787126217
Storage FileStorage

文件存储信息。仅当请求 IncludeContent=true 时返回内容

Permissions String

当前调用方对该文件的权限点列表


注意:此字段可能返回 null,表示取不到有效值。
示例值:[MANAGE]
ReleaseStatus Boolean

是否已发布


注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ResourceMode Integer

资源模式。1=分布式,2=单节点


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AsyncOperation AsyncOperation ZIP 异步创建时透传 Workspace 作业信息;普通同步创建或其他复用该返回结构的接口不设置该字段
注意:此字段可能返回 null,表示取不到有效值。

FileOutputConf

Notebook/Python单元格输出配置

被如下接口引用:CreateFile, GetFile, UpdateFile。

名称 类型 必选 描述
CellId String 单元格 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:17676143448574812
DashboardConf String Dashboard 图表配置,JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"charts":[{"type":"bar"}]}
OutputPath String 执行结果文件的预签名下载链接
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://cos.ap-guangzhou.myqcloud.com/notebook-output/result.csv?sign=xxxx

FileStorage

文件存储

被如下接口引用:CreateFile, GetFile, UpdateFile。

名称 类型 必选 描述
StorageType Integer 存储类型
示例值:1
StoragePath String 存储路径
示例值:/abc
Content String 文件内容
示例值:"hello"

GetWorkflowRsp

GetWorkflowRsp

被如下接口引用:GetWorkflow。

名称 类型 必选 描述
WorkspaceId String

工作空间ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:17622177773248536
BaseInfo WorkflowBaseInfoDetail

工作流基本信息


注意:此字段可能返回 null,表示取不到有效值。
Trigger Array of WorkflowTriggerConfiguration

工作流调度配置


注意:此字段可能返回 null,表示取不到有效值。
ParamList Array of ParamInfo

工作流参数列表


注意:此字段可能返回 null,表示取不到有效值。
LabelList Array of LabelBrief

标签列表


注意:此字段可能返回 null,表示取不到有效值。
Alarm AlarmBrief

工作流告警配置


注意:此字段可能返回 null,表示取不到有效值。
MonitorMetric MonitorMetricBrief

监控指标配置


注意:此字段可能返回 null,表示取不到有效值。
AdvanceConfig WorkflowAdvanceConfig

工作流高级设置


注意:此字段可能返回 null,表示取不到有效值。
TaskList Array of WorkflowTask

工作流任务列表


注意:此字段可能返回 null,表示取不到有效值。
BundleId String

工作流绑定的 Bundle唯一标识,未绑定时为空


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
BundleInfo String

Bundle信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
GitConfigId String

Git配置ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
GitBranch String

Git分支信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:main

GetWorkflowRunRsp

查询工作流运行详情响应。

被如下接口引用:GetWorkflowRun。

名称 类型 必选 描述
WorkflowRun WorkflowRun 工作流运行信息
注意:此字段可能返回 null,表示取不到有效值。

GetWorkflowTaskRunRsp

GetWorkflowTaskRunRsp

被如下接口引用:GetWorkflowTaskRun。

名称 类型 必选 描述
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
WorkflowTaskRunId String 任务运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:2b9d5e77-4c1a-49f8-8a52-13c6f0b9d740
RunState String 运行状态。取值参考工作流任务运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE
WorkspaceId String 工作空间ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:17622177773248536
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
WorkflowRunId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:8f2a1c40-1d33-4f9a-9c21-6b0a7e5d3e11
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskTypeName String 任务类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskVersionId String 任务版本ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
TriggerType String 触发类型 (参考SchedulerTriggerType枚举)
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMMON
ResourceGroupId String 所属资源组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ErrorCodeString String 错误码
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
RunUserUin String 运行用户UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
RunUserName String 运行用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
CreateUserUin String 创建人UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
JobId String 执行平台执行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
CreateTime String 创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
UpdateTime String 更新时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
DependenceFinishedTime String 依赖任务完成时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunStartTime String 运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunEndTime String 运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunCostTime String 运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
WaitTime String 等待时长(依赖就绪到开始运行的等待耗时),单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
IssueTime String 下发执行平台时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
TimeZone String 时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:Asia/Shanghai
DependOnList Array of String 依赖上游任务ID列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["demo"]
RunParams String 运行参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskTypeExtensions String 任务扩展信息,包含脚本路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
LeftCoordinate Float 任务X坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TopCoordinate Float 任务Y坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
RetryTimes Integer 重试次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
RerunTimes Integer 重跑次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsLatestRun Boolean 是否最新一次运行
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ResourceGroupInfoList Array of ResourceGroupInfo 资源组信息列表
注意:此字段可能返回 null,表示取不到有效值。
ErrorMessage String 错误消息
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
RunResult String 运行结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
InnerWorkflowTaskRun InnerWorkflowTaskRun 内嵌工作流任务运行详情(仅限 FOR_EACH 任务,其他任务类型不返回该字段)
注意:此字段可能返回 null,表示取不到有效值。

InnerWorkflowTaskBrief

内嵌工作流任务简要信息(目前只有 FOR_EACH 工作流任务该字段才有值)

被如下接口引用:ListWorkflowTaskRuns。

名称 类型 必选 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskTypeName String 任务类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo

InnerWorkflowTaskRun

内嵌工作流任务运行详情(仅限 FOR_EACH 任务)

被如下接口引用:GetWorkflowTaskRun。

名称 类型 必选 描述
PageNumber Integer 当前页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Items Array of InnerWorkflowTaskRunIteration 迭代运行列表
注意:此字段可能返回 null,表示取不到有效值。
IterationCount Integer 迭代次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FailureCount Integer 失败次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SuccessCount Integer 成功次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InnerWorkflowId String 内嵌工作流ID,可通过 ListWorkflows 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
InnerTaskId String 内嵌任务ID,可通过 ListWorkflowTasks 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
InnerTaskRunBizEnumInfos Array of ScheduleBizEnumBrief 内嵌任务运行状态数量统计(实例业务枚举键值对列表)
注意:此字段可能返回 null,表示取不到有效值。

InnerWorkflowTaskRunIteration

内嵌工作流单次迭代运行信息

被如下接口引用:GetWorkflowTaskRun。

名称 类型 必选 描述
WorkflowRunId String

内嵌工作流运行ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
IterationIndex String

迭代序号


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RunStartTime String

运行开始时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1787026059001
RunEndTime String

运行结束时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1787026058971
RunState String

运行状态(参考工作流运行状态枚举)


注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
RunCostTime String

运行时长,单位:秒


注意:此字段可能返回 null,表示取不到有效值。
示例值:148
WorkflowParams String

运行参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
ErrorCodeString String

错误码


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
InnerTaskRun InnerWorkflowTaskRunIterationBrief

内嵌工作流内部的任务运行


注意:此字段可能返回 null,表示取不到有效值。

InnerWorkflowTaskRunIterationBrief

内嵌工作流迭代中的任务运行简要信息

被如下接口引用:GetWorkflowTaskRun。

名称 类型 必选 描述
WorkflowTaskRunId String

任务运行ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
IterationIndex String

迭代序号


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RunStartTime String

运行开始时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1787026059205
RunEndTime String

运行结束时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1787026058931
RunState String

运行状态


注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
RunCostTime String

运行时长,单位:秒


注意:此字段可能返回 null,表示取不到有效值。
示例值:148286
TaskParams String

运行参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
ErrorCodeString String

错误码


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo

InnerWorkflowTaskRunListOption

内嵌工作流任务运行列表选项(仅限 FOR_EACH 任务使用)

被如下接口引用:GetWorkflowTaskRun。

名称 类型 必选 描述
PageNumber Integer

分页页码,从 1 开始。非必填,默认 1


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer

每页大小。非必填,默认 10,取值范围 [10, 200]


注意:此字段可能返回 null,表示取不到有效值。
示例值:10
RunStates Array of String

迭代运行状态,精确匹配。非必填,多选(多个值之间为 OR 关系)。

可填 SUCCESS / FAILED 等,具体参考本接口出参 InnerWorkflowTaskRunIteration.RunState 字段返回值。


注意:此字段可能返回 null,表示取不到有效值。
示例值:["SUCCESS"]

LabelBrief

标签信息

被如下接口引用:CreateWorkflow, GetWorkflow, GetWorkflowRun, ListWorkflowRuns, ListWorkflows, UpdateWorkflow。

名称 类型 必选 描述
LabelKey String 标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1
LabelValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。
示例值:value1
LabelKeyId String 标签名称ID,可通过标签相关接口获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
LabelValueId String 标签值ID,可通过标签相关接口获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76

ListWorkflowRunsRsp

ListWorkflowRunsRsp

被如下接口引用:ListWorkflowRuns。

名称 类型 必选 描述
PageNumber Integer 当前页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Items Array of WorkflowRun 工作流运行列表
注意:此字段可能返回 null,表示取不到有效值。
BizStateEnumInfos Array of ScheduleBizEnumBrief 工作流运行状态数量统计。
统计口径为当前筛选条件下的全量数据,不受 PageNumber / PageSize 影响
注意:此字段可能返回 null,表示取不到有效值。
BizErrorCodeEnumInfos Array of ScheduleBizEnumBrief 工作流运行错误码数量统计。
统计口径为当前筛选条件下的全量数据,不受 PageNumber / PageSize 影响
注意:此字段可能返回 null,表示取不到有效值。

ListWorkflowTaskRunsRsp

查询工作流任务运行列表响应。

被如下接口引用:ListWorkflowTaskRuns。

名称 类型 必选 描述
PageNumber Integer 当前页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Items Array of WorkflowTaskRun 任务运行历史列表
注意:此字段可能返回 null,表示取不到有效值。

ListWorkflowsRsp

ListWorkflowsRsp

被如下接口引用:ListWorkflows。

名称 类型 必选 描述
PageNumber Integer 当前页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Items Array of WorkflowBrief 工作流列表
注意:此字段可能返回 null,表示取不到有效值。

MonitorMetricBrief

监控指标配置

被如下接口引用:CreateWorkflow, GetWorkflow, UpdateWorkflow。

名称 类型 必选 描述
MonitorMetricId String 监控指标 ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
AlarmMonitorType String 告警的监控对象类型,如工作流、任务等,当前支持 1. WORKFLOW 2. TASK
注意:此字段可能返回 null,表示取不到有效值。
示例值:WORKFLOW
Metrics Array of MonitorMetricItem 监控指标列表
注意:此字段可能返回 null,表示取不到有效值。

MonitorMetricItem

单个监控指标

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
MetricType String 监控指标类型,有三种类型:1. RUN_DURATION(运行时长)2. WAIT_DURATION(等待时长)3. COMPLETION_TIME(完成时间)
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMMON
WarningThreshold String 警告阈值,单位为毫秒级别,对于COMPLETION_TIME:从当日时间点00:00起算
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TimeoutThreshold String 超时阈值,单位为毫秒级别,对于COMPLETION_TIME:从当日时间点00:00起算
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

OrderBy

排序字段

被如下接口引用:ListWorkflowRuns, ListWorkflows。

名称 类型 必选 描述
Direction String 排序方向,Asc(升序)或 Desc(降序),大小写不敏感
示例值:"Desc"
Name String 排序字段名
示例值:"CreateTime"

ParamInfo

参数键值对

被如下接口引用:CreateWorkflow, GetWorkflow, UpdateWorkflow。

名称 类型 必选 描述
ParamId String 参数ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ParamKey String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1
ParamValue String 参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:value1

ResourceGroupInfo

资源组信息

被如下接口引用:GetWorkflowRun, GetWorkflowTaskRun, ListWorkflowRuns, ListWorkflowTaskRuns, ListWorkflows。

名称 类型 必选 描述
ResourceGroupId String 资源组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ResourceGroupName String 资源组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
ResourceGroupStatus String 资源组状态
COMPUTE_RESOURCE_STATUS_UNSPECIFIED 未指定
COMPUTE_RESOURCE_STATUS_PENDING_CREATE 待创建
COMPUTE_RESOURCE_STATUS_CREATING 创建中
COMPUTE_RESOURCE_STATUS_RUNNING 运行中
COMPUTE_RESOURCE_STATUS_STOPPED 已停止
COMPUTE_RESOURCE_STATUS_STOPPING 停止中
COMPUTE_RESOURCE_STATUS_STARTING 启动中
COMPUTE_RESOURCE_STATUS_UPDATING 更新中
COMPUTE_RESOURCE_STATUS_DELETING 删除中
COMPUTE_RESOURCE_STATUS_DELETED 已删除
COMPUTE_RESOURCE_STATUS_FAILED 失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMPUTE_RESOURCE_STATUS_UNSPECIFIED

RunActionBrief

单个操作项的执行结果。 由 RunWorkflow / RerunWorkflowRun / KillWorkflowRun 共用: RunWorkflow—— WorkflowId / WorkflowName 有值,WorkflowRunId 为空 RerunWorkflowRun —— WorkflowId / WorkflowName / WorkflowRunId 均有值 KillWorkflowRun —— WorkflowId / WorkflowName / WorkflowRunId 均有值

被如下接口引用:KillWorkflowRun, RerunWorkflowRun, RunWorkflow。

名称 类型 必选 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
RunActionId String 操作动作ID,用于追踪具体的执行动作
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ErrorMessage String 失败错误信息,操作失败时返回具体的错误描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
OpStatus Boolean 操作状态,true 表示成功,false 表示失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
WorkflowRunId String 工作流运行ID。重跑 / 终止场景返回被操作的运行ID;运行工作流场景为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:8f2a1c40-1d33-4f9a-9c21-6b0a7e5d3e11

ScheduleBizEnumBrief

枚举项统计(如运行状态、错误码的数量分布)

被如下接口引用:GetWorkflowTaskRun, ListWorkflowRuns。

名称 类型 必选 描述
LabelKey String 枚举标签键
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1
LabelValue String 枚举标签值
注意:此字段可能返回 null,表示取不到有效值。
示例值:value1
Count Integer 枚举项统计数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TaskRetryStrategy

任务重试策略

被如下接口引用:CreateWorkflow, ListWorkflows, UpdateWorkflow。

名称 类型 必选 描述
MaxRetryTimes Integer 最多重试次数,默认3
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RetryBetweenWaitTime Integer 重试之间等待时间,默认5
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RetryBetweenWaitTimeUnit String 重试之间等待时间单位
毫秒:MILLISECOND秒:SECOND分钟(默认):MINUTE小时:HOUR
注意:此字段可能返回 null,表示取不到有效值。
示例值:SECOND
TaskRunFailureRetrySwitch Boolean 任务运行失败时重试开关,默认为true
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
TaskRunTimeoutRetrySwitch Boolean 任务运行超时时重试开关,默认为false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

TaskRunConditionRule

任务运行条件规则

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
UpstreamTaskId String 上游任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
UpstreamTaskName String 上游任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
AllowedStates Array of String 任务可运行条件
支持的状态值: - SUCCESS: 成功 - FAILED: 失败 - UPSTREAM_FAILED: 上游失败 - EXCLUDED: 排除运行
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ACTIVE"]

TaskSchedulingParameterBrief

任务调度参数(运行/重跑工作流时的自定义参数)

被如下接口引用:RerunWorkflowRun, RunWorkflow。

名称 类型 必选 描述
ParamKey String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1
ParamValue String 参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:value1

TaskType

TaskTypePropertyListTaskTypeProperty 针对不同任务类型需要填写不同的 key 和 value;

1. NOTEBOOK 任务类型

属性配置

属性键 属性名称 描述 是否必需
Source 来源 可填2或5,来源 2:GIT, 5:工作空间
NotebookPath Notebook 相对路径 Source为5时,需从(ListFiles)获取 Source 为 2、5 时,必填

2. DATA_INTEGRATION 任务类型

属性配置

属性键 属性名称 描述 是否必需
Source 来源 必填:4,表示来源为COS
TemplatePath 数据接入任务配置路径 需从(ListBatchIngestionTasks)接口获取
DataIntegrationTaskId 数据接入任务ID 需从(ListBatchIngestionTasks)接口获取

3. RUN_WORKFLOW 任务类型

属性配置

属性键 属性名称 描述 是否必需
WorkflowId 选择工作流 需从(ListWorkflows)接口获取

4. SQL 任务类型

属性配置

属性键 属性名称 描述 是否必需
Source 来源 可填2或5,来源 2:GIT, 5:工作空间
SqlPath SQL脚本路径 SQL脚本路径 Source 为 2 时,必填
CodeFileName 文件名称 Source为5时,需从(ListReleasedQueries)接口获取
CodeFileId 文件ID Source为5时,需从(ListReleasedQueries)接口获取 Source 为 5 时,必填
CodeFileVersion 文件版本 Source为5时,需从(ListReleasedQueries)接口获取

5. PYTHON 任务类型

属性配置

属性键 属性名称 描述 是否必需
Source 来源 可填2或5,来源 2:GIT, 5:工作空间
SourcePath Python脚本路径 Source为5时,需从(ListFiles)接口获取

6. DATA_QUALITY(质量监控)任务类型

属性配置

属性键 属性名称 描述 是否必需
Source 来源 必填:4,表示来源为COS
TemplatePath 质量监控配置路径 需从(ListDataQualityTaskSummaries)接口获取
SourceUniqueId 质量监控ID 需从(ListDataQualityTaskSummaries)接口获取
ExecutionType 执行类型 必填:SQL
AfterAspect 质量任务后置切面 需从(ListDataQualityTaskSummaries)接口获取
BeforeAspect 质量任务前置切面 需从(ListDataQualityTaskSummaries)接口获取

7. IF_ELSE 任务类型

属性配置

属性键 属性名称 描述 是否必需
Conditions 条件列表 IF-ELSE条件配置

8. FOR_EACH 任务类型

属性配置

属性键 属性名称 描述 是否必需
MaxConcurrency 最大并发数 最大并发数,默认为1
MaxIterations 最大迭代次数 最大迭代次数,默认1000
LoopDataArray 循环参数 JSON格式的数组,或 {{}} 包裹的变量

9. RAY_JOB(Ray作业)任务类型

属性配置

属性键 属性名称 描述 是否必需
RunMode 运行方式 运行方式,取值:SERVERLESS(按需拉起集群)/ DEDICATED(提交到指定集群)。默认 DEDICATED
Entrypoint 入口指令 入口指令
JobConfig 任务配置 如存储配置 + 计算环境。传值请参考前端页面保存Ray作业任务时调用UpdateWorkflow。Image请调用DLC接口ListImages接口Url字段获取 RunMode 为 SERVERLESS 时,必填
ClusterId Ray 集群 需从所选计算资源下已配置的 Ray 集群(引擎)列表中选择,可通过计算资源相关接口获取 RunMode 为 DEDICATED 时,必填
Source 任务来源 任务来源,取值:1(本地文件)/ 5(工作空间)
JobPackage 任务来源文件地址 任务来源路径:Source 为 1 时存本地上传文件的 COS 地址(支持 .zip / .py 文件);Source 为 5 时存所选工作空间文件/文件夹路径
JobPackageName 任务来源本地文件名 任务来源本地文件名 Source 为 1 时,必填
CodeFileId 代码文件ID Source 为 5 时,需从工作空间文件选择组件获取所选文件/文件夹对应的ID Source 为 5 时,必填
WorkspaceEntryType 工作空间入口类型 Source 为 5 时,所选工作空间条目的类型:FILE(文件)/ FOLDER(文件夹),由前端选择器随选择目标自动写入 Source 为 5 时,必填

RuntimePropertyList

任务运行参数列表,用于配置任务运行时的计算资源,与 TaskTypePropertyList(任务扩展属性)区分:TaskTypePropertyList 承载任务自身的业务配置(如脚本来源、路径等),RuntimePropertyList 承载任务运行时的资源配置(如资源模式、CU规格、Executor数量等)。

主要适用于需要配置计算资源的任务类型(如 NOTEBOOK、PYTHON)。

具体可填写的属性键以任务类型属性配置为准,可通过 ListWorkflowTaskTypeProperties 接口获取(propertyType 为 RUNTIME 的属性项)。常见运行参数键说明:

属性键 属性名称 描述 必填性(联动条件满足时) 默认值
ResourceMode 资源模式 1:分布式;2:单节点 1
ConfigType 配置类型 DEFAULT:默认配置;CUSTOM:自定义配置 DEFAULT
ExecutorAllocation Executor分配模式 DYNAMIC:动态分配;FIXED:固定分配 是(分布式且自定义配置时) DYNAMIC
ExecutorMinNum Executor最小个数 正整数 是(动态分配时) 1
ExecutorMaxNum Executor最大个数 正整数 是(动态分配时) 1
ExecutorFixedNum Executor固定个数 正整数 否(固定分配时) -
ExecutorCU Executor资源规格 small / medium / large / xlarge / 4xlarge 否(分布式且自定义配置时) -
DriverCU Driver资源规格 small / medium / large / xlarge / 4xlarge 否(分布式且自定义配置时 或者单节点时) -
ExecutorGPU Executor GPU数量 0表示不使用GPU 否(分布式且自定义配置时) -
DriverGPU Driver GPU数量 0表示不使用GPU 否(分布式且自定义配置时) -
Style 配置样式 UI / JSON 是(自定义配置时) UI

补充说明:

1. "必填性"指属性配置中的必填标记,仅当属性联动条件(如 ResourceMode=1 且 ConfigType=CUSTOM)满足时才触发必填校验;

2. ConfigType 为 DEFAULT(默认配置)时,需调用 ListComputeResourceOptions 接口获取所选计算资源的默认规格值,并将其填充到运行参数(ExecutorCU、DriverCU、ExecutorMinNum、ExecutorMaxNum 等)后传入;ConfigType 为 CUSTOM(自定义配置)时,运行参数由调用方自行指定;

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
TaskTypeName String

任务类型:SQL:用于执行SQL查询和数据处理操作;DATA_INTEGRATION:用于离线数据接入操作;NOTEBOOK:用于运行Notebook脚本;RUN_WORKFLOW:用于执行嵌套工作流;PYTHON:用于运行Python脚本;RAY_JOB:用于运行Ray作业;DATA_QUALITY:用于数据质量监控;IF_ELSE:用于条件分支判断;FOR_EACH:用于循环遍历执行;


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
Notebook TaskTypeNotebookExt

Notebook 类型扩展信息


注意:此字段可能返回 null,表示取不到有效值。
TaskTypePropertyList Array of TaskTypeProperty

任务扩展属性列表,具体填写参考 ListWorkflowTaskTypeProperties 接口


注意:此字段可能返回 null,表示取不到有效值。
RuntimePropertyList Array of TaskTypeProperty

运行时属性列表


注意:此字段可能返回 null,表示取不到有效值。

TaskTypeNotebookExt

Notebook 类型任务扩展

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
Source String 脚本来源。取值:SCRIPT_SOURCE_LOCAL(本地)/ SCRIPT_SOURCE_GIT(Git 仓库)/
SCRIPT_SOURCE_CFS(CFS 文件系统)/ SCRIPT_SOURCE_COS(COS 对象存储)/
SCRIPT_SOURCE_WORKSPACE(工作空间)
注意:此字段可能返回 null,表示取不到有效值。
示例值:SCRIPT_SOURCE_LOCAL
DisplayPath String 前端显示使用,对执行平台无意义
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
NotebookPath String Notebook 相对路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
NotebookAbsolutePath String Notebook 绝对路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo

TaskTypeProperty

任务类型属性键值对

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
PropertyKey String 属性名
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1
PropertyValue String 属性值
注意:此字段可能返回 null,表示取不到有效值。
示例值:value1

UnbindWorkflowBundleRsp

UnbindWorkflowBundleRsp

被如下接口引用:UnbindWorkflowBundle。

名称 类型 必选 描述
Status Boolean 操作状态,true 表示成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

UpdateWorkflowRsp

UpdateWorkflowRsp

被如下接口引用:UpdateWorkflow。

名称 类型 必选 描述
Status Boolean 更新状态,true 表示成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

Workflow

工作流完整配置

被如下接口引用:UpdateWorkflow。

名称 类型 必选 描述
WorkspaceId String

工作空间ID,可通过 ListWorkspaces 获取


注意:此字段可能返回 null,表示取不到有效值。
示例值:17622177773248536
BaseInfo WorkflowBaseInfo

工作流基本信息


注意:此字段可能返回 null,表示取不到有效值。
Trigger Array of WorkflowTriggerConfiguration

工作流调度配置


注意:此字段可能返回 null,表示取不到有效值。
ParamList Array of ParamInfo

工作流参数列表 参数名必填且只能包含数字、大小写字母、空格、.$@#!%^&*()-_+=><!--',最长128个字符-->


注意:此字段可能返回 null,表示取不到有效值。
LabelList Array of LabelBrief

标签 标签名必填且只能包含数字、大小写字母、空格、.$@#!%^&*()-_+=><!--',最长128个字符-->


注意:此字段可能返回 null,表示取不到有效值。
Alarm AlarmBrief

工作流告警配置


注意:此字段可能返回 null,表示取不到有效值。
MonitorMetric MonitorMetricBrief

监控指标配置


注意:此字段可能返回 null,表示取不到有效值。
AdvanceConfig WorkflowAdvanceConfig

工作流高级设置


注意:此字段可能返回 null,表示取不到有效值。
TaskList Array of WorkflowTask

工作流任务列表


注意:此字段可能返回 null,表示取不到有效值。
BundleId String

BundleId,可通过 Bundle 相关接口获取


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
BundleInfo String

Bundle信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
GitConfigId String

GIT配置ID,对应GetWorkspaceConfig接口中的ConfigKey


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
GitBranch String

Git分支信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:main

WorkflowAdvanceConfig

工作流高级设置

被如下接口引用:CreateWorkflow, GetWorkflow, UpdateWorkflow。

名称 类型 必选 描述
QueuingMode String 排队模式,ON(默认), OFF
注意:此字段可能返回 null,表示取不到有效值。
示例值:OFF
MaxConcurrentNum Integer
默认值为1

QueuingMode为ON时,MaxConcurrentNum 设置才生效;只能输入大于0的整数,输入非法值自动转换为1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

WorkflowBaseInfo

工作流基本信息(入参用)

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
WorkflowName String 工作流名称,长度不超过 1024
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
WorkflowId String 工作流ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
RunUserUin String 工作流运行人UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述信息
OwnerUserName String 工作流负责人用户名
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
CreateUserUin String 创建人UIN。系统生成字段,入参传值不生效(服务端忽略且不报错)
【已废弃】服务端忽略传入值,不报错。
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096

WorkflowBaseInfoDetail

工作流基本信息(出参用,含系统生成字段与负责人展示信息)

被如下接口引用:GetWorkflow。

名称 类型 必选 描述
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
CreateUserUin String 创建人UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
RunUserUin String 工作流运行人UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述信息
OwnerUserName String 工作流负责人用户名
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
OwnerUserUin String 工作流负责人UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
OwnerDisplayName String 工作流负责人展示名
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
CreateTime String 创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
UpdateTime String 更新时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000

WorkflowBrief

工作流列表项

被如下接口引用:ListWorkflows。

名称 类型 必选 描述
WorkflowName String

工作流名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
WorkflowId String

工作流ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
Description String

描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:描述信息
CreateUserUin String

创建人UIN


注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
OwnerUserName String

工作流负责人用户名


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
OwnerUserUin String

工作流负责人UIN


注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
OwnerDisplayName String

工作流负责人展示名


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
CreateTime String

创建时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
UpdateTime String

更新时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
LabelList Array of LabelBrief

标签列表


注意:此字段可能返回 null,表示取不到有效值。
Trigger Array of WorkflowTriggerConfiguration

工作流调度配置


注意:此字段可能返回 null,表示取不到有效值。
RunUserUin String

工作流运行人UIN


注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
RunUserName String

工作流运行人用户名


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskList Array of WorkflowTaskNodeBrief

工作流任务节点列表


注意:此字段可能返回 null,表示取不到有效值。
WorkflowRunList Array of WorkflowRunBrief

工作流运行情况列表


注意:此字段可能返回 null,表示取不到有效值。
ResourceGroupInfoList Array of ResourceGroupInfo

资源组信息列表


注意:此字段可能返回 null,表示取不到有效值。
Permission String

工作流权限信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
BundleId String

工作流绑定的 Bundle 唯一标识,未绑定时为空


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
BundleInfo String

Bundle信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
GitConfigId String

Git配置ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
GitBranch String

Git分支信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:main

WorkflowRun

工作流运行信息

被如下接口引用:GetWorkflowRun, ListWorkflowRuns。

名称 类型 必选 描述
AppId String 主账号ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
WorkflowRunId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:8f2a1c40-1d33-4f9a-9c21-6b0a7e5d3e11
WorkspaceId String 工作空间ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:17622177773248536
TriggerType String 触发方式,Scheduler、ManualTrigger、Event (参考SchedulerTriggerType)
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMMON
RunStartTime String 运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
PendingStartTime String pending 状态开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
QueueStartTime String queue 状态开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunEndTime String 运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
EndTime String 终态时间,运行进入终态时都有值,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunCostTime String 运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
QueueCostTime String 并发排队花费时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
PendingCostTime String 等待资源花费时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunState String 运行状态。取值参考工作流运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE
ResourceGroupIds Array of String 计算资源(任务的资源组ID集合)
注意:此字段可能返回 null,表示取不到有效值。
示例值:["f4ec3e79-7368-44c9-8b04-031fad7f1a76"]
RunUserUin String 运行用户UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
RunUserName String 运行用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
ErrorCodeString String 错误码
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
WorkflowParams String 运行参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
WorkflowVersionId String 工作流版本ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
SupportRerun Boolean 当前工作流是否支持重跑
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
CreateTime String 工作流运行创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RerunTimes Integer 重跑次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SelectedTaskIds Array of String 运行的任务范围,任务ID列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["f4ec3e79-7368-44c9-8b04-031fad7f1a76"]
ResourceGroupInfoList Array of ResourceGroupInfo 资源组信息列表
注意:此字段可能返回 null,表示取不到有效值。
LabelList Array of LabelBrief 标签列表
注意:此字段可能返回 null,表示取不到有效值。
ParentWorkflowRunId String 父工作流运行ID 【由嵌套工作流触发独有】
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ParentWorkflowTaskRunId String 父工作流任务运行ID 【由嵌套工作流触发独有】
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ParentWorkflowTaskRunName String 父工作流任务运行名称 【由嵌套工作流触发独有】
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
Permission String 权限信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
AdvancedParameters Array of AdvancedParameter 工作流高级运行时用户填入的参数
注意:此字段可能返回 null,表示取不到有效值。

WorkflowRunBrief

工作流列表项的运行情况

被如下接口引用:ListWorkflows。

名称 类型 必选 描述
WorkflowRunId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:8f2a1c40-1d33-4f9a-9c21-6b0a7e5d3e11
RunStartTime String 运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunState String 运行状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE
ErrorCodeString String 运行错误码
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo

WorkflowTask

工作流任务信息。 注意:本结构同时用于入参(CreateWorkflow / UpdateWorkflow)与出参(GetWorkflow), 其中 CreateTime / UpdateTime / CreateUserUin 为系统生成字段,仅在出参中有值, 入参传值不生效(服务端忽略且不报错)。

被如下接口引用:CreateWorkflow, GetWorkflow, UpdateWorkflow。

名称 类型 必选 描述
ParamList Array of ParamInfo 任务参数
注意:此字段可能返回 null,表示取不到有效值。
DependOnList Array of DependOnBrief 任务依赖
注意:此字段可能返回 null,表示取不到有效值。
TaskId String 任务ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskType TaskType 任务类型
注意:此字段可能返回 null,表示取不到有效值。
ResourceGroupId String 资源组ID,可通过资源组相关接口获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
Description String 任务描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述信息
Alarm AlarmBrief 任务告警
注意:此字段可能返回 null,表示取不到有效值。
MonitorMetric MonitorMetricBrief 监控指标
注意:此字段可能返回 null,表示取不到有效值。
TaskRetryStrategy TaskRetryStrategy 任务重试策略
注意:此字段可能返回 null,表示取不到有效值。
DependOnRunCondition String

任依赖运行条件

  • ALL_SUCCESS: 全部成功:所有上游依赖任务均已执行并成功
  • ONE_SUCCESS: 至少一个成功:至少有一个上游依赖任务成功
  • NONE_FAILED: 目前没有失败:没有依赖任务失败,并且至少有一个依赖任务在运行中
  • ALL_DONE: 全部完成:所有上游依赖任务均已执行并完成(无论成功或失败
  • ONE_FAILED: 至少一个失败:至少有一个上游依赖任务失败
  • ALL_FAILED: 全部失败:所有上游依赖任务都失败
  • ALL_DONE_AT_LEAST_ONE_SUCCESS:上游全部完成至少一个成功: 所有上游依赖任务都达到终态时,进行依赖判断,至少有一个成功,则依赖判断成功,否则就是跳过运行
  • ALL_SKIPPED:上游全部完成,没有跳过运行: 所有上游依赖任务都达到终态时,进行依赖判断, 如果上游状态全部都是成功、失败、上游失败状态,则依赖判断成功,否则为跳过运行
  • ONE_DONE:至少一个完成:上游只要有一个完成了,就进行依赖判断,且依赖判断成功,否则还是等待上游
  • ALL_DONE_NONE_FAILED_AT_LEAST_ONE_SUCCESS:上游全部完成,没有失败,至少有一个成功: 所有上游依赖任务都达到终态时,进行依赖判断,上游没有一个失败且至少有一个成功的情况下,依赖判断成功,否则就是跳过运行
  • NONE_SKIPPED:上游全部完成,没有跳过运行: 所有上游依赖任务都达到终态时,进行依赖判断, 如果上游状态全部都是成功、失败、上游失败状态,则依赖判断成功,否则为跳过运行
  • ALL_DONE_AT_LEAST_ONE_FAILED:上游全部完成至少一个失败: 所有上游依赖任务都达到终态时,进行依赖判断,至少有一个失败,则依赖判断成功,否则就是跳过运行
  • ADVANCED:运行条件为高级模式时配置

注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
LeftCoordinate Float 任务X坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TopCoordinate Float 任务Y坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
AdvancedDependencyConfig AdvancedDependencyConfig

任务高级运行参数,当DependOnRunCondition为ADVANCED时配置


注意:此字段可能返回 null,表示取不到有效值。
InnerTask WorkflowTask

内嵌任务(FOR_EACH任务的子任务)


注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间,单位:毫秒时间戳。出参专用,系统生成,入参传值不生效
【已废弃】服务端忽略传入值,不报错。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
UpdateTime String 更新时间,单位:毫秒时间戳。出参专用,系统生成,入参传值不生效
【已废弃】服务端忽略传入值,不报错。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
CreateUserUin String 创建人UIN。出参专用,系统生成,入参传值不生效
【已废弃】服务端忽略传入值,不报错。
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096

WorkflowTaskNodeBrief

工作流列表项中的工作流任务节点简要信息

被如下接口引用:ListWorkflows。

名称 类型 必选 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskTypeName String 任务类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
DependOnList Array of DependOnBrief 任务依赖列表
注意:此字段可能返回 null,表示取不到有效值。
ResourceGroupId String 任务资源组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ResourceGroupName String 任务资源组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
LeftCoordinate Float 任务X坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TopCoordinate Float 任务Y坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TaskRetryStrategy TaskRetryStrategy 任务重试策略
注意:此字段可能返回 null,表示取不到有效值。
DependOnRunCondition String 依赖运行条件
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
AdvancedDependencyConfig AdvancedDependencyConfig 高级依赖配置
注意:此字段可能返回 null,表示取不到有效值。
InnerTask WorkflowTaskNodeBrief 内嵌工作流任务节点
注意:此字段可能返回 null,表示取不到有效值。

WorkflowTaskRun

工作流任务运行信息

被如下接口引用:ListWorkflowTaskRuns。

名称 类型 必选 描述
TaskName String

任务名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
WorkflowTaskRunId String

任务运行ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:2b9d5e77-4c1a-49f8-8a52-13c6f0b9d740
RunState String

运行状态。取值参考工作流任务运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed


注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE
WorkspaceId String

工作空间ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:17622177773248536
WorkflowId String

工作流ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
WorkflowRunId String

工作流运行ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:8f2a1c40-1d33-4f9a-9c21-6b0a7e5d3e11
TaskId String

任务ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskTypeName String

任务类型名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskVersionId String

任务版本ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
TriggerType String

触发类型 (参考SchedulerTriggerType枚举)


注意:此字段可能返回 null,表示取不到有效值。
示例值:COMMON
ResourceGroupId String

所属资源组ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
ErrorCodeString String

错误码


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
RunUserUin String

运行用户UIN


注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
RunUserName String

运行用户名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
CreateUserUin String

创建人UIN


注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
JobId String

执行平台执行ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
CreateTime String

创建时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
UpdateTime String

更新时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
DependenceFinishedTime String

依赖任务完成时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunStartTime String

运行开始时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunEndTime String

运行结束时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
RunCostTime String

运行时长,单位:秒


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
WaitTime String

等待时长(依赖就绪到开始运行的等待耗时),单位:秒


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
IssueTime String

下发执行平台时间,单位:毫秒时间戳


注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
TimeZone String

时区


注意:此字段可能返回 null,表示取不到有效值。
示例值:Asia/Shanghai
DependOnList Array of String

依赖上游任务ID列表


注意:此字段可能返回 null,表示取不到有效值。
示例值:["demo"]
RunParams String

运行参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
TaskTypeExtensions String

任务扩展信息,包含脚本路径


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
LeftCoordinate Float

任务X坐标


注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TopCoordinate Float

任务Y坐标


注意:此字段可能返回 null,表示取不到有效值。
示例值:50
RetryTimes Integer

重试次数,为 0 则表示首次运行


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
WorkflowName String

工作流名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo_workflow
RerunTimes Integer

重跑次数


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsLatestRun Boolean

是否最新一次运行


注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ResourceGroupInfoList Array of ResourceGroupInfo

资源组信息列表


注意:此字段可能返回 null,表示取不到有效值。
RunResult String

运行结果


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
DependOnRunCondition String

依赖运行条件


注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
AdvancedDependencyConfig AdvancedDependencyConfig

高级依赖配置


注意:此字段可能返回 null,表示取不到有效值。
InnerTask InnerWorkflowTaskBrief

内嵌工作流任务信息


注意:此字段可能返回 null,表示取不到有效值。

WorkflowTriggerAdvancedConfiguration

工作流调度高级配置。

被如下接口引用:CreateWorkflow, UpdateWorkflow。

名称 类型 必选 描述
TaskRetryMode String 任务重试模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMMON

WorkflowTriggerConfiguration

工作流调度配置。

被如下接口引用:CreateWorkflow, GetWorkflow, ListWorkflows, UpdateWorkflow。

名称 类型 必选 描述
TriggerId String 调度配置ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
SchedulerStatus String 调度状态 启动:START,暂停:PAUSE
注意:此字段可能返回 null,表示取不到有效值。
示例值:START
TriggerMode String 触发方式,
- 定时触发:TIME_TRIGGER
- 持续运行:CONTINUE_RUN

注意:
- TIME_TRIGGER 模式下,SchedulerStatus、SchedulerTimeZone、StartTime、EndTime、ConfigMode、CycleType、CrontabExpression 必填;
- CONTINUE_RUN 模式下,AdvancedConfig必填;
注意:此字段可能返回 null,表示取不到有效值。
示例值:TIME_TRIGGER
SchedulerTimeZone String 调度时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:Asia/Shanghai
StartTime String 调度生效时间,单位:毫秒时间戳。必须小于 EndTime
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
EndTime String 调度结束时间,单位:毫秒时间戳。必须大于 StartTime
注意:此字段可能返回 null,表示取不到有效值。
示例值:1773244800000
ConfigMode String 配置方式,常规:COMMON,CRON表达式:CRON_EXPRESSION
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMMON
CycleType String 周期类型:支持的类型为 ONEOFF_CYCLE: 一次性 YEAR_CYCLE: 年 MONTH_CYCLE: 月 WEEK_CYCLE: 周 DAY_CYCLE: 天
HOUR_CYCLE: 小时 MINUTE_CYCLE: 分钟 CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:ONEOFF_CYCLE
CrontabExpression String cron表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:0 0 0 * * ? *
ExtraInfo String Json格式,对账使用
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
AdvancedConfig WorkflowTriggerAdvancedConfiguration 高级配置
注意:此字段可能返回 null,表示取不到有效值。