/** * 任务依赖简要信息 */ export interface DependOnBrief { /** * 任务ID,可通过 ListWorkflowTasks 获取 注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: string; /** * 任务名称 注意:此字段可能返回 null,表示取不到有效值。 */ TaskName?: string; } /** * ListConsoleGroupUsers请求参数结构体 */ export interface ListConsoleGroupUsersRequest { /** *
用户组 ID
*/ GroupId: string; /** *用户名称或 UIN 模糊匹配
*/ UserKeyword?: string; /** *通过 UIN 批量查询用户信息
*/ UserUins?: Array多字段排序,如 [{Name: 'CreateTime', Direction: 'DESC'}, {Name: 'UserName', Direction: 'ASC'}],默认按创建时间降序
*/ OrderBys?: Array页码,从1开始,默认1
*/ PageNumber?: number; /** *每页大小,默认10,最小10,最大200
*/ PageSize?: number; } /** * ListConsoleGroups请求参数结构体 */ export interface ListConsoleGroupsRequest { /** *页码,从1开始,默认1
*/ PageNumber?: number; /** *每页大小,默认10,最小10,最大200
*/ PageSize?: number; /** *通过用户组 ID 批量查询
*/ GroupIds?: Array用户组名称模糊匹配
*/ GroupKeyword?: string; /** *多字段排序,如 [{Name: 'CreateTime', Direction: 'Desc'}, {Name: 'UserName', Direction: 'Asc'}],默认按创建时间降序
*/ OrderBys?: Array返回结果
*/ Data?: UpdateConsoleUsersRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 工作流完整配置 */ export interface Workflow { /** *工作空间ID,可通过 ListWorkspaces 获取
注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** *工作流基本信息
注意:此字段可能返回 null,表示取不到有效值。 */ BaseInfo?: WorkflowBaseInfo; /** *工作流调度配置
注意:此字段可能返回 null,表示取不到有效值。 */ Trigger?: Array工作流参数列表 参数名必填且只能包含数字、大小写字母、空格、.$@#!%^&*()-_+=>
注意:此字段可能返回 null,表示取不到有效值。 */ ParamList?: Array标签 标签名必填且只能包含数字、大小写字母、空格、.$@#!%^&*()-_+=>
注意:此字段可能返回 null,表示取不到有效值。 */ LabelList?: Array工作流告警配置
注意:此字段可能返回 null,表示取不到有效值。 */ Alarm?: AlarmBrief; /** *监控指标配置
注意:此字段可能返回 null,表示取不到有效值。 */ MonitorMetric?: MonitorMetricBrief; /** *工作流高级设置
注意:此字段可能返回 null,表示取不到有效值。 */ AdvanceConfig?: WorkflowAdvanceConfig; /** *工作流任务列表
注意:此字段可能返回 null,表示取不到有效值。 */ TaskList?: ArrayBundleId,可通过 Bundle 相关接口获取
注意:此字段可能返回 null,表示取不到有效值。 */ BundleId?: string; /** *Bundle信息
注意:此字段可能返回 null,表示取不到有效值。 */ BundleInfo?: string; /** *GIT配置ID,对应GetWorkspaceConfig接口中的ConfigKey
注意:此字段可能返回 null,表示取不到有效值。 */ GitConfigId?: string; /** *Git分支信息
注意:此字段可能返回 null,表示取不到有效值。 */ GitBranch?: string; } /** * 任务重试策略 */ export interface TaskRetryStrategy { /** * 最多重试次数,默认3 注意:此字段可能返回 null,表示取不到有效值。 */ MaxRetryTimes?: number; /** * 重试之间等待时间,默认5 注意:此字段可能返回 null,表示取不到有效值。 */ RetryBetweenWaitTime?: number; /** * 重试之间等待时间单位 毫秒:MILLISECOND秒:SECOND分钟(默认):MINUTE小时:HOUR 注意:此字段可能返回 null,表示取不到有效值。 */ RetryBetweenWaitTimeUnit?: string; /** * 任务运行失败时重试开关,默认为true 注意:此字段可能返回 null,表示取不到有效值。 */ TaskRunFailureRetrySwitch?: boolean; /** * 任务运行超时时重试开关,默认为false 注意:此字段可能返回 null,表示取不到有效值。 */ TaskRunTimeoutRetrySwitch?: boolean; } /** * 文件存储 */ export interface FileStorage { /** * 存储类型 */ StorageType?: number; /** * 存储路径 */ StoragePath?: string; /** * 文件内容 */ Content?: string; } /** * 计划调度时间配置 */ export interface ScheduledTimeConfig { /** *调度时区,IANA 时区 ID
注意:此字段可能返回 null,表示取不到有效值。 */ ScheduledTimeZone?: string; /** *调度生效开始时间
参数格式:毫秒时间戳(UTC)
注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; /** *调度生效结束时间
参数格式:毫秒时间戳(UTC)
注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** *周期类型
枚举值:
周期步长
注意:此字段可能返回 null,表示取不到有效值。 */ CycleNum?: number; } /** * DeleteWorkflow返回参数结构体 */ export interface DeleteWorkflowResponse { /** *删除工作流响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: DeleteWorkflowRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询控制台角色列表响应 */ export interface ListConsoleRolesRsp { /** * 角色列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array控制台用户列表
*/ Data?: ListConsoleUsersRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveConsoleUsers返回参数结构体 */ export interface RemoveConsoleUsersResponse { /** *批量移除控制台用户结果
*/ Data?: RemoveConsoleUsersRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 内嵌工作流任务简要信息(目前只有 FOR_EACH 工作流任务该字段才有值) */ export interface InnerWorkflowTaskBrief { /** * 任务ID 注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: string; /** * 任务名称 注意:此字段可能返回 null,表示取不到有效值。 */ TaskName?: string; /** * 任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述 注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeName?: string; } /** * 监控指标配置 */ export interface MonitorMetricBrief { /** * 监控指标 ID,创建时无需传入,由服务端生成 注意:此字段可能返回 null,表示取不到有效值。 */ MonitorMetricId?: string; /** * 告警的监控对象类型,如工作流、任务等,当前支持 1. WORKFLOW 2. TASK 注意:此字段可能返回 null,表示取不到有效值。 */ AlarmMonitorType?: string; /** * 监控指标列表 注意:此字段可能返回 null,表示取不到有效值。 */ Metrics?: Array内嵌工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunId?: string; /** *迭代序号
注意:此字段可能返回 null,表示取不到有效值。 */ IterationIndex?: string; /** *运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunStartTime?: string; /** *运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunEndTime?: string; /** *运行状态(参考工作流运行状态枚举)
注意:此字段可能返回 null,表示取不到有效值。 */ RunState?: string; /** *运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ RunCostTime?: string; /** *运行参数
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowParams?: string; /** *错误码
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCodeString?: string; /** *内嵌工作流内部的任务运行
注意:此字段可能返回 null,表示取不到有效值。 */ InnerTaskRun?: InnerWorkflowTaskRunIterationBrief; } /** * DeleteWorkflow请求参数结构体 */ export interface DeleteWorkflowRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *待删除的工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; } /** * ListWorkflowTaskRuns请求参数结构体 */ export interface ListWorkflowTaskRunsRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *任务ID,可通过 ListWorkflowTasks 获取。非必填,精确匹配。与 WorkflowRunId 至少传一个:仅传 TaskId 时查询该任务的全部运行历史。
*/ TaskId?: string; /** *工作流运行ID,可通过 ListWorkflowRuns 获取。非必填,精确匹配。与 TaskId 至少传一个:仅传 WorkflowRunId 时查询该次工作流运行下的全部任务运行。
*/ WorkflowRunId?: string; /** *分页页码,从 1 开始。非必填,默认 1
*/ PageNumber?: number; /** *每页大小。非必填,默认 10,取值范围 [10, 200]
*/ PageSize?: number; } /** * 告警配置 */ export interface AlarmBrief { /** * 告警 ID,创建时无需传入,由服务端生成 注意:此字段可能返回 null,表示取不到有效值。 */ AlarmId?: string; /** * 告警的监控对象类型,如工作流、任务等,当前支持 1. WORKFLOW 2. TASK 注意:此字段可能返回 null,表示取不到有效值。 */ AlarmMonitorType?: string; /** * 告警组,最多 50 个 注意:此字段可能返回 null,表示取不到有效值。 */ AlarmGroups?: Array工作流ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** *任务ID
注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: string; /** *任务名称
注意:此字段可能返回 null,表示取不到有效值。 */ TaskName?: string; /** *任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述
注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeName?: string; /** *任务依赖列表
注意:此字段可能返回 null,表示取不到有效值。 */ DependOnList?: Array任务资源组ID
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupId?: string; /** *任务资源组名称
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupName?: string; /** *任务X坐标
注意:此字段可能返回 null,表示取不到有效值。 */ LeftCoordinate?: number; /** *任务Y坐标
注意:此字段可能返回 null,表示取不到有效值。 */ TopCoordinate?: number; /** *任务重试策略
注意:此字段可能返回 null,表示取不到有效值。 */ TaskRetryStrategy?: TaskRetryStrategy; /** *任依赖运行条件
高级依赖配置
注意:此字段可能返回 null,表示取不到有效值。 */ AdvancedDependencyConfig?: AdvancedDependencyConfig; /** *内嵌工作流任务节点
注意:此字段可能返回 null,表示取不到有效值。 */ InnerTask?: WorkflowTaskNodeBrief; } /** * 修改控制台用户响应 */ export interface UpdateConsoleUsersRsp { /** * 操作是否成功 */ Status?: boolean; } /** * CreateWorkflow请求参数结构体 */ export interface CreateWorkflowRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流基本信息。必填,其中 WorkflowName 必填且工作空间内唯一
*/ BaseInfo: WorkflowBaseInfo; /** *工作流调度配置
*/ Trigger?: Array工作流参数列表
*/ ParamList?: Array标签列表
*/ LabelList?: Array工作流告警配置
*/ Alarm?: AlarmBrief; /** *监控指标配置。若告警条件中选择了监控告警,则本字段必填
*/ MonitorMetric?: MonitorMetricBrief; /** *工作流高级设置
*/ AdvanceConfig?: WorkflowAdvanceConfig; /** *工作流任务列表
*/ TaskList?: ArrayBundleId,可通过 Bundle 相关接口获取
*/ BundleId?: string; /** *Bundle信息
*/ BundleInfo?: string; /** *Git配置ID,可通过 Git 配置相关接口获取
*/ GitConfigId?: string; /** *Git分支信息
*/ GitBranch?: string; } /** * 工作流列表项的运行情况 */ export interface WorkflowRunBrief { /** * 工作流运行ID 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunId?: string; /** * 运行开始时间,单位:毫秒时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ RunStartTime?: string; /** * 运行状态 注意:此字段可能返回 null,表示取不到有效值。 */ RunState?: string; /** * 运行错误码 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCodeString?: string; } /** * 工作流调度高级配置。 */ export interface WorkflowTriggerAdvancedConfiguration { /** * 任务重试模式 注意:此字段可能返回 null,表示取不到有效值。 */ TaskRetryMode?: string; } /** * 批量异步操作的逐项结果 */ export interface AsyncActionRsp { /** * 多个操作项的结果列表 注意:此字段可能返回 null,表示取不到有效值。 */ ActionResults?: Array返回结果
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: FileInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务调度参数(运行/重跑工作流时的自定义参数) */ export interface TaskSchedulingParameterBrief { /** * 参数名 注意:此字段可能返回 null,表示取不到有效值。 */ ParamKey?: string; /** * 参数值 注意:此字段可能返回 null,表示取不到有效值。 */ ParamValue?: string; } /** * UpdateWorkflow请求参数结构体 */ export interface UpdateWorkflowRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *待更新的工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; /** *需要清空的字段名列表,用于将指定字段重置为空
*/ FieldToRemoveList?: Array更新后的工作流配置,仅传入需要变更的部分即可
*/ NewSetting?: Workflow; } /** * 任务运行条件规则 */ export interface TaskRunConditionRule { /** *上游任务ID
注意:此字段可能返回 null,表示取不到有效值。 */ UpstreamTaskId?: string; /** *上游任务名称
注意:此字段可能返回 null,表示取不到有效值。 */ UpstreamTaskName?: string; /** *任务可运行条件
支持的状态值: - SUCCESS: 成功 - FAILED: 失败 - UPSTREAM_FAILED: 上游失败 - EXCLUDED: 排除运行
资源组ID
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupId?: string; /** *资源组名称
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupName?: string; /** *资源组状态
参数格式:0 // 未指定 1 // 待创建 2 // 创建中 3 // 运行中 4 // 已停止 5 // 停止中 6 // 启动中 7 // 更新中 8 // 删除中 9 // 已删除 10 // 用户主动启动 / 自动启动(有任务提交且自动启停开启) 11 // 可用: 仅存在于数据计算型 12 // 不可用: 仅存在于数据计算型 13 // 失败
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupStatus?: string; } /** * UnbindWorkflowBundle返回参数结构体 */ export interface UnbindWorkflowBundleResponse { /** *解绑工作流Bundle信息响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: UnbindWorkflowBundleRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 修改控制台用户组响应 */ export interface UpdateConsoleGroupRsp { /** * 操作是否成功 */ Status?: boolean; } /** * UnbindWorkflowBundleRsp */ export interface UnbindWorkflowBundleRsp { /** * 操作状态,true 表示成功 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: boolean; } /** * KillWorkflowRun返回参数结构体 */ export interface KillWorkflowRunResponse { /** *终止工作流的运行响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: AsyncActionRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 添加控制台用户响应 */ export interface AddConsoleUsersRsp { /** * 操作是否成功 */ Status?: boolean; } /** * ListWorkflows请求参数结构体 */ export interface ListWorkflowsRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *分页页码,从 1 开始。非必填,默认 1
*/ PageNumber?: number; /** *每页大小。非必填,默认 10,取值范围 [10, 200]
*/ PageSize?: number; /** *工作流名称关键字,对 WorkflowName 做模糊匹配。非必填,单值
*/ WorkflowNameKeyword?: string; /** *工作流名称,精确匹配。非必填,多选(多个值之间为 OR 关系)
*/ WorkflowNames?: Array工作流ID,精确匹配。非必填,多选(多个值之间为 OR 关系)
*/ WorkflowIds?: Array工作流运行人UIN,精确匹配。非必填,多选(多个值之间为 OR 关系)
*/ RunUserUins?: Array标签名称ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)
*/ LabelKeyIds?: Array标签值ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)
*/ LabelValueIds?: Array快速筛选类型。非必填,单值
对齐老云 API(wedata/2025-10-10)文档示例值:
后端实现现状:当前仅 MY_FAVORITE 生效(设置 favoriteUserUin 过滤当前用户收藏),MY_OWNER / MY_AUTHORITY 暂未在 Service 层实现,传入会被忽略(按全量返回)。
*/ QuickSelectionType?: string; /** *排序条件,多个之间按数组顺序表示优先级。非必填。
可排序字段白名单:CreateTime
工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *分页页码,从 1 开始。非必填,默认 1
*/ PageNumber?: number; /** *每页大小。非必填,默认 10,取值范围 [10, 200]
*/ PageSize?: number; /** *工作流ID,精确匹配。非必填,单值
*/ WorkflowId?: string; /** *工作流名称关键字,对 WorkflowName 做模糊匹配。非必填,单值
*/ WorkflowNameKeyword?: string; /** *运行创建时间下界,范围匹配(CreateTime >= 本值),单位:毫秒时间戳。
非必填,单值,对应出参 WorkflowRun.CreateTime
运行创建时间上界,范围匹配(CreateTime <= 本值),单位:毫秒时间戳。
非必填,单值,对应出参 WorkflowRun.CreateTime
运行状态,精确匹配。非必填,多选(多个值之间为 OR 关系)。
可填 SUCCESS / FAILED 等,具体参考本接口出参 WorkflowRun.RunState 字段返回值。
*/ RunStates?: Array错误码,精确匹配。非必填,多选(多个值之间为 OR 关系)
*/ ErrorCodeStrings?: Array运行人UIN,精确匹配。非必填,多选(多个值之间为 OR 关系)
*/ RunUserUins?: Array标签名称ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)
*/ LabelKeyIds?: Array标签值ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)
*/ LabelValueIds?: Array排序条件,多个之间按数组顺序表示优先级。非必填,默认按 CreateTime Desc。
可排序字段白名单:CreateTime、EndTime、RunCostTime
调度配置ID,创建时无需传入,由服务端生成
注意:此字段可能返回 null,表示取不到有效值。 */ TriggerId?: string; /** *调度状态 启动:START,暂停:PAUSE
注意:此字段可能返回 null,表示取不到有效值。 */ SchedulerStatus?: string; /** *触发方式,
注意:
调度时区
注意:此字段可能返回 null,表示取不到有效值。 */ SchedulerTimeZone?: string; /** *调度生效时间,单位:毫秒时间戳。必须小于 EndTime
注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; /** *调度结束时间,单位:毫秒时间戳。必须大于 StartTime
注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** *配置方式,常规:COMMON,CRON表达式:CRON_EXPRESSION
注意:此字段可能返回 null,表示取不到有效值。 */ ConfigMode?: string; /** *周期类型:支持的类型为 ONEOFF_CYCLE: 一次性 YEAR_CYCLE: 年 MONTH_CYCLE: 月 WEEK_CYCLE: 周 DAY_CYCLE: 天
HOUR_CYCLE: 小时 MINUTE_CYCLE: 分钟 CRONTAB_CYCLE: crontab表达式类型
cron表达式
注意:此字段可能返回 null,表示取不到有效值。 */ CrontabExpression?: string; /** *Json格式,对账使用
注意:此字段可能返回 null,表示取不到有效值。 */ ExtraInfo?: string; /** *高级配置
注意:此字段可能返回 null,表示取不到有效值。 */ AdvancedConfig?: WorkflowTriggerAdvancedConfiguration; } /** * GetWorkflowTaskRun返回参数结构体 */ export interface GetWorkflowTaskRunResponse { /** *查询任务运行详情响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: GetWorkflowTaskRunRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetFile请求参数结构体 */ export interface GetFileRequest { /** *工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId
*/ WorkspaceId: string; /** *文件 ID。来源:CreateFile / ListFiles 接口返回的 FileId。与 FilePath 二选一
*/ FileId?: string; /** *文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType
*/ FileType?: string; /** *是否返回文件内容。true 时 Storage.Content 返回 base64 内容,默认 false
*/ IncludeContent?: boolean; /** *文件版本 ID。来源:ListFileVersions 接口返回的 VersionId。不传则读取最新版本
*/ VersionId?: string; /** *文件完整路径,以 / 开头,如 /etl/daily/demo.ipynb。与 FileId 二选一
*/ FilePath?: string; } /** * 工作流基本信息(入参用) */ export interface WorkflowBaseInfo { /** * 工作流名称,长度不超过 1024 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowName?: string; /** * 工作流ID,创建时无需传入,由服务端生成 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** * 工作流运行人UIN 注意:此字段可能返回 null,表示取不到有效值。 */ RunUserUin?: string; /** * 描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * 工作流负责人用户名 注意:此字段可能返回 null,表示取不到有效值。 */ OwnerUserName?: string; /** * 创建人UIN。系统生成字段,入参传值不生效(服务端忽略且不报错) 【已废弃】服务端忽略传入值,不报错。 注意:此字段可能返回 null,表示取不到有效值。 */ CreateUserUin?: string; } /** * ### `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(自定义配置)时,运行参数由调用方自行指定;
*/ export interface TaskType { /** *任务类型:SQL:用于执行SQL查询和数据处理操作;DATA_INTEGRATION:用于离线数据接入操作;NOTEBOOK:用于运行Notebook脚本;RUN_WORKFLOW:用于执行嵌套工作流;PYTHON:用于运行Python脚本;RAY_JOB:用于运行Ray作业;DATA_QUALITY:用于数据质量监控;IF_ELSE:用于条件分支判断;FOR_EACH:用于循环遍历执行;
注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeName?: string; /** *Notebook 类型扩展信息
注意:此字段可能返回 null,表示取不到有效值。 */ Notebook?: TaskTypeNotebookExt; /** *任务扩展属性列表,具体填写参考 ListWorkflowTaskTypeProperties 接口
注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypePropertyList?: Array运行时属性列表
注意:此字段可能返回 null,表示取不到有效值。 */ RuntimePropertyList?: Array重跑工作流响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: AsyncActionRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWorkflowRsp */ export interface CreateWorkflowRsp { /** * 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; } /** * GetFile返回参数结构体 */ export interface GetFileResponse { /** *返回结果
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: FileInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OneFlow 透传的 Workspace 异步文件操作信息;作业状态由 Workspace 持久化和维护 */ export interface AsyncOperation { /** * 是否异步执行;ZIP 解压创建时为 true 注意:此字段可能返回 null,表示取不到有效值。 */ IsAsync: boolean; /** * Workspace 持久化的异步作业 ID,用于查询作业进度 注意:此字段可能返回 null,表示取不到有效值。 */ JobId: string; /** * 调用方生成的提交幂等与链路追踪标识 注意:此字段可能返回 null,表示取不到有效值。 */ OperationId: string; /** * 异步作业状态:0-未指定,1-已受理,2-解压中,3-回调处理中,4-成功,5-部分失败,6-失败 注意:此字段可能返回 null,表示取不到有效值。 */ Status: number; } /** * 角色元数据 */ export interface RoleMetaData { /** * 创建者 */ Creator?: string; /** * 创建时间 */ CreateTime?: string; /** * 更新者 */ Updater?: string; /** * 更新时间 */ UpdateTime?: string; } /** * 查询工作流运行详情响应。 */ export interface GetWorkflowRunRsp { /** * 工作流运行信息 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRun?: WorkflowRun; } /** * ListConsoleGroupUsers返回参数结构体 */ export interface ListConsoleGroupUsersResponse { /** *返回结果
*/ Data?: ListConsoleGroupUsersRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询工作流任务运行列表响应。 */ export interface ListWorkflowTaskRunsRsp { /** * 当前页码 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页大小 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总记录数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPageNumber?: number; /** * 任务运行历史列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array任务名称
注意:此字段可能返回 null,表示取不到有效值。 */ TaskName?: string; /** *任务运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowTaskRunId?: string; /** *运行状态。取值参考工作流任务运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed
注意:此字段可能返回 null,表示取不到有效值。 */ RunState?: string; /** *工作空间ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** *工作流ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** *工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunId?: string; /** *任务ID
注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: string; /** * 任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述 注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeName?: string; /** *任务版本ID
注意:此字段可能返回 null,表示取不到有效值。 */ TaskVersionId?: string; /** *触发类型 (参考SchedulerTriggerType枚举)
注意:此字段可能返回 null,表示取不到有效值。 */ TriggerType?: string; /** *所属资源组ID
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupId?: string; /** *错误码
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCodeString?: string; /** *运行用户UIN
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserUin?: string; /** *运行用户名称
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserName?: string; /** *创建人UIN
注意:此字段可能返回 null,表示取不到有效值。 */ CreateUserUin?: string; /** *执行平台执行ID
注意:此字段可能返回 null,表示取不到有效值。 */ JobId?: string; /** *创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *更新时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** *依赖任务完成时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ DependenceFinishedTime?: string; /** *运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunStartTime?: string; /** *运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunEndTime?: string; /** *运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ RunCostTime?: string; /** *等待时长(依赖就绪到开始运行的等待耗时),单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ WaitTime?: string; /** *下发执行平台时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ IssueTime?: string; /** *时区
注意:此字段可能返回 null,表示取不到有效值。 */ TimeZone?: string; /** *依赖上游任务ID列表。保留字段,暂时返回为[]
保留字段,暂时返回为[]
注意:此字段可能返回 null,表示取不到有效值。 */ DependOnList?: Array运行参数
注意:此字段可能返回 null,表示取不到有效值。 */ RunParams?: string; /** *任务扩展信息,包含脚本路径
注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeExtensions?: string; /** *任务X坐标
注意:此字段可能返回 null,表示取不到有效值。 */ LeftCoordinate?: number; /** *任务Y坐标
注意:此字段可能返回 null,表示取不到有效值。 */ TopCoordinate?: number; /** *重试次数,为 0 则表示首次运行
注意:此字段可能返回 null,表示取不到有效值。 */ RetryTimes?: number; /** *工作流名称
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowName?: string; /** *重跑次数
注意:此字段可能返回 null,表示取不到有效值。 */ RerunTimes?: number; /** *是否最新一次运行
注意:此字段可能返回 null,表示取不到有效值。 */ IsLatestRun?: boolean; /** *资源组信息列表
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupInfoList?: Array运行结果
注意:此字段可能返回 null,表示取不到有效值。 */ RunResult?: 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,表示取不到有效值。 */ AdvancedDependencyConfig?: AdvancedDependencyConfig; /** *内嵌工作流任务信息
注意:此字段可能返回 null,表示取不到有效值。 */ InnerTask?: InnerWorkflowTaskBrief; /** *计划调度时间
参数格式:毫秒时间戳,UTC
注意:此字段可能返回 null,表示取不到有效值。 */ ScheduledTime?: string; } /** * 内嵌工作流迭代中的任务运行简要信息 */ export interface InnerWorkflowTaskRunIterationBrief { /** *任务运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowTaskRunId?: string; /** *迭代序号
注意:此字段可能返回 null,表示取不到有效值。 */ IterationIndex?: string; /** *运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunStartTime?: string; /** *运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunEndTime?: string; /** *运行状态
注意:此字段可能返回 null,表示取不到有效值。 */ RunState?: string; /** *运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ RunCostTime?: string; /** *运行参数
注意:此字段可能返回 null,表示取不到有效值。 */ TaskParams?: string; /** *错误码
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCodeString?: string; } /** * CreateConsoleGroup请求参数结构体 */ export interface CreateConsoleGroupRequest { /** *用户组名称
*/ GroupName: string; /** *用户组别名
*/ GroupNickname?: string; /** *用户组描述
*/ Description?: string; } /** * ListWorkflowsRsp */ export interface ListWorkflowsRsp { /** * 当前页码 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页大小 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总记录数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPageNumber?: number; /** * 工作流列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; /** *工作流运行ID,可通过 ListWorkflowRuns 获取。必填
*/ WorkflowRunId: string; /** *运行类型。必填。取值:1 普通运行,2 高级运行
*/ RunType: number; /** *运行类型为高级运行时填写的自定义运行参数
*/ AdvancedParams?: Array本次需要重跑指定的任务ID集合,可通过 ListWorkflowTasks 获取,不传默认重跑该工作流下所有任务
*/ TaskIds?: Array计划调度时间列表配置
*/ ScheduledTimeConfig?: ScheduledTimeConfig; } /** * ListWorkflows返回参数结构体 */ export interface ListWorkflowsResponse { /** *查询工作流列表响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: ListWorkflowsRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标签信息 */ export interface LabelBrief { /** * 标签名称 注意:此字段可能返回 null,表示取不到有效值。 */ LabelKey?: string; /** * 标签值 注意:此字段可能返回 null,表示取不到有效值。 */ LabelValue?: string; /** * 标签名称ID,可通过标签相关接口获取 注意:此字段可能返回 null,表示取不到有效值。 */ LabelKeyId?: string; /** * 标签值ID,可通过标签相关接口获取 注意:此字段可能返回 null,表示取不到有效值。 */ LabelValueId?: string; } /** * AddConsoleUsers请求参数结构体 */ export interface AddConsoleUsersRequest { /** *用户 UIN 列表,单次最多100个
*/ UserUins: Array角色 ID 列表
枚举值:
工作流名称
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowName?: string; /** *工作流ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** *描述
注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** *创建人UIN
注意:此字段可能返回 null,表示取不到有效值。 */ CreateUserUin?: string; /** *工作流负责人用户名
注意:此字段可能返回 null,表示取不到有效值。 */ OwnerUserName?: string; /** *工作流负责人UIN
注意:此字段可能返回 null,表示取不到有效值。 */ OwnerUserUin?: string; /** *工作流负责人展示名
注意:此字段可能返回 null,表示取不到有效值。 */ OwnerDisplayName?: string; /** *创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *更新时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** *标签列表
注意:此字段可能返回 null,表示取不到有效值。 */ LabelList?: Array工作流调度配置
注意:此字段可能返回 null,表示取不到有效值。 */ Trigger?: Array工作流运行人UIN
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserUin?: string; /** *工作流运行人用户名
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserName?: string; /** *工作流任务节点列表
注意:此字段可能返回 null,表示取不到有效值。 */ TaskList?: Array工作流运行情况列表
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunList?: Array资源组信息列表
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupInfoList?: Array授权权限类型
PERMISSION_TYPE_UNSPECIFIED:未指定权限
MANAGE : 管理权限:包含所有操作权限
RUN : 运行权限:可执行实体
VIEW : 查看权限:可查看实体内容
工作流绑定的 Bundle 唯一标识,未绑定时为空
注意:此字段可能返回 null,表示取不到有效值。 */ BundleId?: string; /** *Bundle信息
注意:此字段可能返回 null,表示取不到有效值。 */ BundleInfo?: string; /** *Git配置ID
注意:此字段可能返回 null,表示取不到有效值。 */ GitConfigId?: string; /** *Git分支信息
注意:此字段可能返回 null,表示取不到有效值。 */ GitBranch?: string; } /** * KillWorkflowRun请求参数结构体 */ export interface KillWorkflowRunRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; /** *待终止的工作流运行ID列表,可通过 ListWorkflowRuns 获取
*/ WorkflowRunIds?: Array是否终止该工作流下所有未进入终态的运行。非必填,默认 false
*/ KillAllRuns?: boolean; /** *是否只终止处于等待中(Pending)状态的运行。非必填,默认 false
*/ OnlyKillPendingRuns?: boolean; } /** * ListWorkflowTaskRuns返回参数结构体 */ export interface ListWorkflowTaskRunsResponse { /** *查询工作流任务历史运行列表响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: ListWorkflowTaskRunsRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddConsoleUsers返回参数结构体 */ export interface AddConsoleUsersResponse { /** *返回结果
*/ Data?: AddConsoleUsersRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListConsoleGroups返回参数结构体 */ export interface ListConsoleGroupsResponse { /** *返回结果
*/ Data?: ListConsoleGroupsRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 控制台角色信息(对外标准版,与内部 Role 解耦) */ export interface ConsoleRoleInfo { /** * 角色基本信息 注意:此字段可能返回 null,表示取不到有效值。 */ BasicInfo?: RoleBasicInfo; /** * 角色元信息 注意:此字段可能返回 null,表示取不到有效值。 */ MetaData?: RoleMetaData; /** * 角色权限 注意:此字段可能返回 null,表示取不到有效值。 */ Permissions?: Array被删除的文件 ID
注意:此字段可能返回 null,表示取不到有效值。 */ FileId?: string; /** *删除是否成功
注意:此字段可能返回 null,表示取不到有效值。 */ Status?: boolean; } /** * 单个操作项的执行结果。 由 RunWorkflow / RerunWorkflowRun / KillWorkflowRun 共用: RunWorkflow—— WorkflowId / WorkflowName 有值,WorkflowRunId 为空 RerunWorkflowRun —— WorkflowId / WorkflowName / WorkflowRunId 均有值 KillWorkflowRun —— WorkflowId / WorkflowName / WorkflowRunId 均有值 */ export interface RunActionBrief { /** * 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** * 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowName?: string; /** * 操作动作ID,用于追踪具体的执行动作 注意:此字段可能返回 null,表示取不到有效值。 */ RunActionId?: string; /** * 失败错误信息,操作失败时返回具体的错误描述 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** * 操作状态,true 表示成功,false 表示失败 注意:此字段可能返回 null,表示取不到有效值。 */ OpStatus?: boolean; /** * 工作流运行ID。重跑 / 终止场景返回被操作的运行ID;运行工作流场景为空 注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunId?: string; } /** * Notebook/Python单元格输出配置 */ export interface FileOutputConf { /** * 单元格 ID 注意:此字段可能返回 null,表示取不到有效值。 */ CellId?: string; /** * Dashboard 图表配置,JSON 字符串 注意:此字段可能返回 null,表示取不到有效值。 */ DashboardConf?: string; /** * 执行结果文件的预签名下载链接 注意:此字段可能返回 null,表示取不到有效值。 */ OutputPath?: string; } /** * RunWorkflow请求参数结构体 */ export interface RunWorkflowRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; /** *运行类型。必填。取值:1 普通运行,2 高级运行
*/ RunType: number; /** *运行类型为高级运行时填写的自定义运行参数
*/ AdvancedParams?: Array本次需要运行指定的任务ID集合,可通过 ListWorkflowTasks 获取,不传默认运行该工作流下所有任务
*/ TaskIds?: Array幂等令牌。非必填,相同令牌的重复请求只会触发一次运行
*/ IdempotencyToken?: string; /** *计划调度时间列表配置
*/ ScheduledTimeConfig?: ScheduledTimeConfig; } /** * UpdateConsoleGroup请求参数结构体 */ export interface UpdateConsoleGroupRequest { /** *用户组 ID
*/ GroupId: string; /** *修改标识:USER_GROUP_OPER_TYPE_ADD_USER(1)=添加成员、USER_GROUP_OPER_TYPE_DELETE_USER(2)=删除成员、USER_GROUP_OPER_TYPE_BASIC_INFO(3)=基础信息(别名和描述)
*/ OperType: number; /** *用户组名称
*/ GroupName?: string; /** *用户组别名
*/ GroupNickname?: string; /** *用户组描述
*/ Description?: string; /** *成员 UIN 列表(OperType 为添加/删除成员时使用)
*/ UserUins?: Array主账号 AppId
注意:此字段可能返回 null,表示取不到有效值。 */ AppId?: string; /** *工作空间 ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** *文件 ID
注意:此字段可能返回 null,表示取不到有效值。 */ FileId?: string; /** *文件名,含后缀
注意:此字段可能返回 null,表示取不到有效值。 */ FileName?: string; /** *文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType
注意:此字段可能返回 null,表示取不到有效值。 */ FileType?: string; /** *文件在工作空间中的完整路径,以 / 开头,如 /etl/daily/demo.ipynb
注意:此字段可能返回 null,表示取不到有效值。 */ Path?: string; /** *文件运行配置
*/ FileConfig?: FileConfig; /** *绑定的 BundleId
注意:此字段可能返回 null,表示取不到有效值。 */ BundleId?: string; /** *绑定的 BundleInfo,JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。 */ BundleInfo?: string; /** *文件状态。active=正常,deleted=已删除
注意:此字段可能返回 null,表示取不到有效值。 */ Status?: string; /** *文件负责人用户名
注意:此字段可能返回 null,表示取不到有效值。 */ OwnerUserName?: string; /** *创建人子账号 Uin
注意:此字段可能返回 null,表示取不到有效值。 */ CreateUserUin?: string; /** *最近更新人子账号 Uin
注意:此字段可能返回 null,表示取不到有效值。 */ UpdateUserUin?: string; /** *创建时间,毫秒级时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *最近更新时间,毫秒级时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** *文件存储信息。仅当请求 IncludeContent=true 时返回内容
*/ Storage?: FileStorage; /** *当前调用方对该文件的权限点列表
注意:此字段可能返回 null,表示取不到有效值。 */ Permissions?: string; /** *是否已发布
注意:此字段可能返回 null,表示取不到有效值。 */ ReleaseStatus?: boolean; /** *资源模式。1=分布式,2=单节点
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceMode?: number; /** * ZIP 异步创建时透传 Workspace 作业信息;普通同步创建或其他复用该返回结构的接口不设置该字段 注意:此字段可能返回 null,表示取不到有效值。 */ AsyncOperation?: AsyncOperation; } /** * GetWorkflow返回参数结构体 */ export interface GetWorkflowResponse { /** *获取工作流详细信息响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: GetWorkflowRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetWorkflowTaskRun请求参数结构体 */ export interface GetWorkflowTaskRunRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *任务运行ID,可通过 ListWorkflowTaskRuns 获取。必填
*/ WorkflowTaskRunId: string; /** *内嵌工作流任务运行列表选项(仅限 FOR_EACH 任务使用)。非必填
*/ InnerWorkflowTaskRunListOption?: InnerWorkflowTaskRunListOption; } /** * DeleteFile返回参数结构体 */ export interface DeleteFileResponse { /** *返回结果
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: DeleteFileResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateConsoleGroup返回参数结构体 */ export interface CreateConsoleGroupResponse { /** *返回结果
*/ Data?: CreateConsoleGroupRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 工作流任务信息。 注意:本结构同时用于入参(CreateWorkflow / UpdateWorkflow)与出参(GetWorkflow), 其中 CreateTime / UpdateTime / CreateUserUin 为系统生成字段,仅在出参中有值, 入参传值不生效(服务端忽略且不报错)。 */ export interface WorkflowTask { /** * 任务参数 注意:此字段可能返回 null,表示取不到有效值。 */ ParamList?: Array任依赖运行条件
任务高级运行参数,当DependOnRunCondition为ADVANCED时配置
注意:此字段可能返回 null,表示取不到有效值。 */ AdvancedDependencyConfig?: AdvancedDependencyConfig; /** *内嵌任务(FOR_EACH任务的子任务)
注意:此字段可能返回 null,表示取不到有效值。 */ InnerTask?: WorkflowTask; /** * 创建时间,单位:毫秒时间戳。出参专用,系统生成,入参传值不生效 【已废弃】服务端忽略传入值,不报错。 注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** * 更新时间,单位:毫秒时间戳。出参专用,系统生成,入参传值不生效 【已废弃】服务端忽略传入值,不报错。 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** * 创建人UIN。出参专用,系统生成,入参传值不生效 【已废弃】服务端忽略传入值,不报错。 注意:此字段可能返回 null,表示取不到有效值。 */ CreateUserUin?: string; } /** * 高级依赖配置 */ export interface AdvancedDependencyConfig { /** * 逻辑运算符号OR / AND 注意:此字段可能返回 null,表示取不到有效值。 */ Operator?: string; /** * 任务运行条件规则列表 注意:此字段可能返回 null,表示取不到有效值。 */ Conditions?: Array要删除的用户组 ID 列表
*/ GroupIds: Array更新工作流响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: UpdateWorkflowRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetWorkflow请求参数结构体 */ export interface GetWorkflowRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; } /** * 内嵌工作流任务运行列表选项(仅限 FOR_EACH 任务使用) */ export interface InnerWorkflowTaskRunListOption { /** *分页页码,从 1 开始。非必填,默认 1
注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** *每页大小。非必填,默认 10,取值范围 [10, 200]
注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** *迭代运行状态,精确匹配。非必填,多选(多个值之间为 OR 关系)。
可填 SUCCESS / FAILED 等,具体参考本接口出参 InnerWorkflowTaskRunIteration.RunState 字段返回值。
注意:此字段可能返回 null,表示取不到有效值。 */ RunStates?: Array主账号ID
注意:此字段可能返回 null,表示取不到有效值。 */ AppId?: string; /** *工作流名称
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowName?: string; /** *工作流ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** *工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunId?: string; /** *工作空间ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** *触发方式,Scheduler、ManualTrigger、Event (参考SchedulerTriggerType)
注意:此字段可能返回 null,表示取不到有效值。 */ TriggerType?: string; /** *运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunStartTime?: string; /** *pending 状态开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ PendingStartTime?: string; /** *queue 状态开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ QueueStartTime?: string; /** *运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunEndTime?: string; /** *终态时间,运行进入终态时都有值,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** *运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ RunCostTime?: string; /** *并发排队花费时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ QueueCostTime?: string; /** *等待资源花费时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ PendingCostTime?: string; /** *运行状态。CREATE("初始化"), QUEUED("等待中"), PENDING("准备中"), RUNNING("运行中"), SKIPPED("跳过运行"), SUCCESS("成功"), FAILED("失败"), TERMINATING("终止中"), TERMINATED("终止"), CANCELLED("被手动终止")等
注意:此字段可能返回 null,表示取不到有效值。 */ RunState?: string; /** *计算资源(任务的资源组ID集合)
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupIds?: Array运行用户UIN
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserUin?: string; /** *运行用户名称
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserName?: string; /** *错误码
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCodeString?: string; /** *运行参数
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowParams?: string; /** *工作流版本ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowVersionId?: string; /** *当前工作流是否支持重跑
注意:此字段可能返回 null,表示取不到有效值。 */ SupportRerun?: boolean; /** *工作流运行创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *重跑次数
注意:此字段可能返回 null,表示取不到有效值。 */ RerunTimes?: number; /** *运行的任务范围,任务ID列表
注意:此字段可能返回 null,表示取不到有效值。 */ SelectedTaskIds?: Array资源组信息列表
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupInfoList?: Array标签列表
注意:此字段可能返回 null,表示取不到有效值。 */ LabelList?: Array父工作流运行ID 【由嵌套工作流触发独有】
注意:此字段可能返回 null,表示取不到有效值。 */ ParentWorkflowRunId?: string; /** *父工作流任务运行ID 【由嵌套工作流触发独有】
注意:此字段可能返回 null,表示取不到有效值。 */ ParentWorkflowTaskRunId?: string; /** *父工作流任务运行名称 【由嵌套工作流触发独有】
注意:此字段可能返回 null,表示取不到有效值。 */ ParentWorkflowTaskRunName?: string; /** *授权权限类型
PERMISSION_TYPE_UNSPECIFIED:未指定权限
MANAGE : 管理权限:包含所有操作权限
RUN : 运行权限:可执行实体
VIEW : 查看权限:可查看实体内容
工作流高级运行时用户填入的参数
注意:此字段可能返回 null,表示取不到有效值。 */ AdvancedParameters?: Array计划调度时间
参数格式:毫秒时间戳(UTC)
注意:此字段可能返回 null,表示取不到有效值。 */ ScheduledTime?: string; } /** * 任务类型属性键值对 */ export interface TaskTypeProperty { /** * 属性名 注意:此字段可能返回 null,表示取不到有效值。 */ PropertyKey?: string; /** * 属性值 注意:此字段可能返回 null,表示取不到有效值。 */ PropertyValue?: string; } /** * ListWorkflowRunsRsp */ export interface ListWorkflowRunsRsp { /** * 当前页码 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页大小 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总记录数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPageNumber?: number; /** * 工作流运行列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId
*/ WorkspaceId: string; /** *文件名,含后缀,最长 255 字节。不能以 . 或 .. 开头/结尾,不能含空格与控制字符
*/ FileName: string; /** *父文件夹路径,以 / 开头、末尾不带 /,根目录传 /。来源:ListFiles 接口返回的 Path
*/ ParentFolderPath?: string; /** *文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType
*/ FileType?: string; /** *文件运行配置
*/ FileConfig?: FileConfig; /** *绑定的 BundleId。来源:ListBundles 接口返回的 BundleId
*/ BundleId?: string; /** *绑定的 BundleInfo,JSON 字符串
*/ BundleInfo?: string; /** *文件初始内容。不传则按FileType 生成默认内容
*/ Storage?: FileStorage; /** * 是否将 Storage 中的 ZIP 文件异步解压创建,默认 false。true 时异步作业由 Workspace 负责全生命周期,响应仅通过 AsyncOperation 返回作业信息(FileId 为空);作业进度查询由基础平台 WS 接口实现,不在本协议中定义。 */ ExtractArchive?: boolean; } /** * UpdateFile请求参数结构体 */ export interface UpdateFileRequest { /** *工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId
*/ WorkspaceId: string; /** *文件 ID。来源:CreateFile / ListFiles / GetFile 接口返回的 FileId
*/ FileId: string; /** *文件运行配置。不传则不更新配置
*/ FileConfig?: FileConfig; /** *文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType
*/ FileType?: string; /** *绑定的 BundleId。来源:ListBundles 接口返回的 BundleId
*/ BundleId?: string; /** *绑定的 BundleInfo,JSON 字符串
*/ BundleInfo?: string; /** *文件内容。不传则不更新内容
*/ Storage?: FileStorage; /** *目标文件名,非空且与当前文件名不同时执行 rename 动作。长度不超过 SCRIPT_NAME_MAX_LENGTH,禁止以 . 或 .. 开头/结尾,禁止空格、双点、控制字符及 Linux 保留名(参考 docs/linux_filename_rules.md)。与 ExtensionType 一起校验后缀合法性
*/ FileName?: string; /** *目标父目录路径,非空时执行 move 动作。根目录传 /;与 FileName 可同时出现,语义为「移动+重命名」。与 CreateFile 的 ParentFolderPath 保持一致
*/ ParentFolderPath?: string; /** *目标父目录的 FileType。取值:FOLDER、GIT_FOLDER。仅当 ParentFolderPath 非空时使用;缺省时按解析出的父目录实际类型处理
*/ TargetFileType?: string; /** *动作类型(必填,未来版本会强制校验)。取值:1 = UPDATE_CONTENT(仅更新 FileConfig / Storage / Bundle*,禁止传 FileName / ParentFolderPath / TargetFileType);2 = RENAME(仅重命名,必须传 FileName,禁止传 ParentFolderPath / FileConfig / Storage / Bundle*);3 = MOVE(仅移动,必须传 ParentFolderPath,禁止传 FileName / FileConfig / Storage / Bundle*)。参数互斥校验失败会返回 ParamIllegal 错误
*/ UpdateAction?: number; } /** * GetWorkflowRun请求参数结构体 */ export interface GetWorkflowRunRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流运行ID,可通过 ListWorkflowRuns 获取。必填
*/ WorkflowRunId: string; } /** * RemoveConsoleUsers请求参数结构体 */ export interface RemoveConsoleUsersRequest { /** *必填,待移除的用户 UIN 列表,单次最多10个
*/ UserUins: Array高级运行参数,变量替换用,map-json String,String
注意:此字段可能返回 null,表示取不到有效值。 */ Params?: string; /** *执行资源 ID。来源:ListComputeResources 接口返回的 ResourceId
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceId?: string; /** *默认 catalog
注意:此字段可能返回 null,表示取不到有效值。 */ DefaultCatalog?: string; /** *默认 schema
注意:此字段可能返回 null,表示取不到有效值。 */ DefaultSchema?: string; /** *高级配置,JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。 */ AdvanceConfig?: string; /** *扩展参数,JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。 */ ExtraParams?: string; /** *Notebook 交互控件定义,JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。 */ Widgets?: string; /** *各单元格输出配置。仅 Get 出参返回,入参忽略
*/ OutputConf?: ArraySQL脚本语法标记
注意:此字段可能返回 null,表示取不到有效值。 */ SqlSyntax?: string; /** *平台集群id
注意:此字段可能返回 null,表示取不到有效值。 */ ClusterId?: string; } /** * RunWorkflow返回参数结构体 */ export interface RunWorkflowResponse { /** *运行工作流响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: AsyncActionRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListConsoleUsers请求参数结构体 */ export interface ListConsoleUsersRequest { /** *页码,从1开始,默认1
*/ PageNumber?: number; /** *每页大小,默认10,最小10,最大200
*/ PageSize?: number; /** *用户名称与 UIN 模糊匹配
*/ UserKeyword?: string; /** *用于过滤角色关联的用户
枚举值:
多字段排序,如 [{Name: 'CreateTime', Direction: 'Desc'}, {Name: 'UserName', Direction: 'Asc'}],默认按创建时间降序
*/ OrderBys?: Array工作流运行列表响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: ListWorkflowRunsRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 高级运行参数(工作流高级运行时用户填入的参数) */ export interface AdvancedParameter { /** * 参数名 注意:此字段可能返回 null,表示取不到有效值。 */ ParamKey?: string; /** * 参数值 注意:此字段可能返回 null,表示取不到有效值。 */ ParamValue?: string; } /** * UpdateConsoleGroup返回参数结构体 */ export interface UpdateConsoleGroupResponse { /** *返回结果
*/ Data?: UpdateConsoleGroupRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 控制台用户信息(规范化,与内部 UserDetailInfo 解耦) */ export interface ConsoleUserInfo { /** * 用户 UIN */ UserUin?: string; /** * 用户名 */ UserName?: string; /** * 昵称 */ Nickname?: string; /** * 角色列表 注意:此字段可能返回 null,表示取不到有效值。 */ Roles?: Array返回结果
*/ Data?: DeleteConsoleGroupsRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 内嵌工作流任务运行详情(仅限 FOR_EACH 任务) */ export interface InnerWorkflowTaskRun { /** * 当前页码 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页大小 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总记录数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPageNumber?: number; /** * 迭代运行列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array创建工作流响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: CreateWorkflowRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListConsoleRoles请求参数结构体 */ export interface ListConsoleRolesRequest { /** *页码,从1开始,默认1
*/ PageNumber?: number; /** *每页大小,默认10,最小10,最大200
*/ PageSize?: number; /** *角色名称或描述模糊匹配
*/ RoleKeyword?: string; } /** * 查询控制台用户组成员列表响应 */ export interface ListConsoleGroupUsersRsp { /** * 用户组成员列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId
*/ WorkspaceId: string; /** *文件 ID。来源:CreateFile / ListFiles / GetFile 接口返回的 FileId
*/ FileId: string; /** *文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType
*/ FileType?: string; } /** * DeleteWorkflowRsp */ export interface DeleteWorkflowRsp { /** * 删除状态,true 表示成功 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: boolean; } /** * 通用错误信息 */ export interface CommonFailItem { /** *uin或者groupId
*/ Item?: string; /** *错误信息
*/ FailReason?: string; } /** * 批量移除控制台用户响应 */ export interface RemoveConsoleUsersRsp { /** *请求已完成处理;即使部分失败也为 true,逐个结果以 SuccessUins/FailItems 为准
*/ Status?: boolean; /** *删除成功的用户 UIN 列表
*/ SuccessUins?: Array失败项列表(Item 为用户 UIN,FailReason 为失败原因)
*/ FailItems?: Array查询工作流运行详情响应内容
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: GetWorkflowRunRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询控制台用户列表响应 */ export interface ListConsoleUsersRsp { /** * 用户列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array工作空间ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** *工作流基本信息
注意:此字段可能返回 null,表示取不到有效值。 */ BaseInfo?: WorkflowBaseInfoDetail; /** *工作流调度配置
注意:此字段可能返回 null,表示取不到有效值。 */ Trigger?: Array工作流参数列表
注意:此字段可能返回 null,表示取不到有效值。 */ ParamList?: Array标签列表
注意:此字段可能返回 null,表示取不到有效值。 */ LabelList?: Array工作流告警配置
注意:此字段可能返回 null,表示取不到有效值。 */ Alarm?: AlarmBrief; /** *监控指标配置
注意:此字段可能返回 null,表示取不到有效值。 */ MonitorMetric?: MonitorMetricBrief; /** *工作流高级设置
注意:此字段可能返回 null,表示取不到有效值。 */ AdvanceConfig?: WorkflowAdvanceConfig; /** *工作流任务列表
注意:此字段可能返回 null,表示取不到有效值。 */ TaskList?: Array工作流绑定的 Bundle唯一标识,未绑定时为空
注意:此字段可能返回 null,表示取不到有效值。 */ BundleId?: string; /** *Bundle信息
注意:此字段可能返回 null,表示取不到有效值。 */ BundleInfo?: string; /** *Git配置ID
注意:此字段可能返回 null,表示取不到有效值。 */ GitConfigId?: string; /** *Git分支信息
注意:此字段可能返回 null,表示取不到有效值。 */ GitBranch?: string; } /** * UnbindWorkflowBundle请求参数结构体 */ export interface UnbindWorkflowBundleRequest { /** *工作空间ID,可通过 ListWorkspaces 获取。必填
*/ WorkspaceId: string; /** *工作流ID,可通过 ListWorkflows 获取。必填
*/ WorkflowId: string; } /** * 角色基础信息 */ export interface RoleBasicInfo { /** *角色ID
*/ Id?: string; /** *角色名称
*/ Name?: string; /** *角色描述
*/ Description?: string; /** *显示名称
*/ DisplayName?: string; /** *角色类型
*/ RoleType?: string; /** *角色来源,参考 web_enum_standard.proto -> RoleSource:0=未指定 1=用户直绑 2=用户组继承 3=两者都有
*/ Source?: number; /** *继承来源的用户组名称列表,Source=1 时为空
*/ GroupNames?: Array返回结果
*/ Data?: ListConsoleRolesRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateFile返回参数结构体 */ export interface UpdateFileResponse { /** *返回结果
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: FileInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateConsoleUsers请求参数结构体 */ export interface UpdateConsoleUsersRequest { /** *用户 UIN 列表,单次最多100个
*/ UserUins: Array角色 ID 列表
枚举值:
任务名称
注意:此字段可能返回 null,表示取不到有效值。 */ TaskName?: string; /** *任务运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowTaskRunId?: string; /** *运行状态。取值参考工作流任务运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed
注意:此字段可能返回 null,表示取不到有效值。 */ RunState?: string; /** *工作空间ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** *工作流ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowId?: string; /** *工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowRunId?: string; /** *任务ID
注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: string; /** * 任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述 注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeName?: string; /** *任务版本ID
注意:此字段可能返回 null,表示取不到有效值。 */ TaskVersionId?: string; /** *触发类型 (参考SchedulerTriggerType枚举)
注意:此字段可能返回 null,表示取不到有效值。 */ TriggerType?: string; /** *所属资源组ID
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupId?: string; /** *错误码
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCodeString?: string; /** *运行用户UIN
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserUin?: string; /** *运行用户名称
注意:此字段可能返回 null,表示取不到有效值。 */ RunUserName?: string; /** *创建人UIN
注意:此字段可能返回 null,表示取不到有效值。 */ CreateUserUin?: string; /** *执行平台执行ID
注意:此字段可能返回 null,表示取不到有效值。 */ JobId?: string; /** *创建时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *更新时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** *依赖任务完成时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ DependenceFinishedTime?: string; /** *运行开始时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunStartTime?: string; /** *运行结束时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ RunEndTime?: string; /** *运行时长,单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ RunCostTime?: string; /** *等待时长(依赖就绪到开始运行的等待耗时),单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ WaitTime?: string; /** *下发执行平台时间,单位:毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ IssueTime?: string; /** *时区
注意:此字段可能返回 null,表示取不到有效值。 */ TimeZone?: string; /** *依赖上游任务ID列表。保留字段,暂时返回为[]
保留字段,暂时返回为[]
注意:此字段可能返回 null,表示取不到有效值。 */ DependOnList?: Array运行参数
注意:此字段可能返回 null,表示取不到有效值。 */ RunParams?: string; /** *任务扩展信息,包含脚本路径
注意:此字段可能返回 null,表示取不到有效值。 */ TaskTypeExtensions?: string; /** *任务X坐标
注意:此字段可能返回 null,表示取不到有效值。 */ LeftCoordinate?: number; /** *任务Y坐标
注意:此字段可能返回 null,表示取不到有效值。 */ TopCoordinate?: number; /** *重试次数
注意:此字段可能返回 null,表示取不到有效值。 */ RetryTimes?: number; /** *工作流名称
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowName?: string; /** *重跑次数
注意:此字段可能返回 null,表示取不到有效值。 */ RerunTimes?: number; /** *是否最新一次运行
注意:此字段可能返回 null,表示取不到有效值。 */ IsLatestRun?: boolean; /** *资源组信息列表
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupInfoList?: Array错误消息
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** *运行结果
注意:此字段可能返回 null,表示取不到有效值。 */ RunResult?: string; /** *内嵌工作流任务运行详情(仅限 FOR_EACH 任务,其他任务类型不返回该字段)
注意:此字段可能返回 null,表示取不到有效值。 */ InnerWorkflowTaskRun?: InnerWorkflowTaskRun; /** *计划调度时间
参数格式:毫秒时间戳(UTC)
注意:此字段可能返回 null,表示取不到有效值。 */ ScheduledTime?: string; }