AdvancedDependencyConfig
高级依赖配置
被如下接口引用：CreateWorkflow, GetWorkflow, ListWorkflows, UpdateWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Operator | String | 否 | 逻辑运算符号OR / AND 注意：此字段可能返回 null，表示取不到有效值。 示例值：AND |
| Conditions | Array of TaskRunConditionRule | 否 | 任务运行条件规则列表 注意：此字段可能返回 null，表示取不到有效值。 |
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, GetWorkflow, 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 |
CreateWorkflowRsp
CreateWorkflowRsp
被如下接口引用：CreateWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WorkflowId | String | 否 | 工作流ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：f4ec3e79-7368-44c9-8b04-031fad7f1a76 |
DeleteWorkflowRsp
DeleteWorkflowRsp
被如下接口引用：DeleteWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Status | Boolean | 否 | 删除状态，true 表示成功 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
DependOnBrief
任务依赖简要信息
被如下接口引用：CreateWorkflow, GetWorkflow, ListWorkflows, UpdateWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TaskId | String | 否 | 任务ID，可通过 ListWorkflowTasks 获取 注意：此字段可能返回 null，表示取不到有效值。 示例值：a4dfb8d2-cc55-4a24-8573-0091b791a927 |
| TaskName | String | 否 | 任务名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：demo |
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 |
LabelBrief
标签信息
被如下接口引用：CreateWorkflow, GetWorkflow, 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 |
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, GetWorkflow, 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
排序字段
被如下接口引用：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
资源组信息
被如下接口引用：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 |
TaskRetryStrategy
任务重试策略
被如下接口引用：CreateWorkflow, GetWorkflow, 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, GetWorkflow, 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"] |
TaskType
TaskTypePropertyList 中 TaskTypeProperty 针对不同任务类型需要填写不同的 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, GetWorkflow, 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, GetWorkflow, 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, GetWorkflow, UpdateWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PropertyKey | String | 否 | 属性名 注意：此字段可能返回 null，表示取不到有效值。 示例值：key1 |
| PropertyValue | String | 否 | 属性值 注意：此字段可能返回 null，表示取不到有效值。 示例值：value1 |
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 |
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 | 否 | 任依赖运行条件
注意：此字段可能返回 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，表示取不到有效值。 |
WorkflowTriggerAdvancedConfiguration
工作流调度高级配置。
被如下接口引用：CreateWorkflow, GetWorkflow, 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，表示取不到有效值。 |
