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

数据结构

最近更新时间:2026-09-29 01:53:38
我的收藏

AddConsoleUsersRsp

添加控制台用户响应

被如下接口引用:AddConsoleUsers。

名称 类型 描述
Status Boolean 操作是否成功
示例值:true

AdvancedDependencyConfig

高级依赖配置

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

名称 类型 必选 描述
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。

名称 类型 必选 描述
ChannelId String 否

通知渠道ID,可通过基础平台通知渠道相关接口获取


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

通知渠道名称,可以是用户组名称或邮箱地址


注意:此字段可能返回 null,表示取不到有效值。
示例值:119*71@*q.com
IsEmailChannel Boolean 否

是否启用邮件渠道,默认值:false


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

告警条件列表。取值:
START:启动
SUCCESS:成功
FAILURE:失败
MONITOR_INDICATOR_ALARM:监控指标告警


注意:此字段可能返回 null,表示取不到有效值。
示例值:["START","FAILURE"]
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

CommonFailItem

通用错误信息

被如下接口引用:RemoveConsoleUsers。

名称 类型 描述
Item String

uin或者groupId


示例值:334
FailReason String

错误信息


示例值:用户不在Agent席位中

ConsoleGroupInfo

控制台用户组信息(对外标准版,与内部 UserGroupRoleInfo 解耦)

被如下接口引用:ListConsoleGroups。

名称 类型 描述
GroupId String 用户组 ID
示例值:17676143448574812
GroupName String 用户组名称
示例值:group_name
Roles Array of RoleBasicInfo 角色列表
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
示例值:2025-01-01 00:00:00
UpdateTime String 更新时间
示例值:2025-01-01 00:00:00
UserCount Integer 用户组下用户数量
示例值:10
GroupType String 用户组类型。取值为枚举数值的字符串形式:"0"=控制台系统类型(包含全部user)、"1"=控制台自定义类型、"2"=工作空间系统类型、"3"=工作空间自定义类型
示例值:0

ConsoleGroupUserInfo

控制台用户组成员信息(对外标准版,与内部 GroupUserInfo 解耦)

被如下接口引用:ListConsoleGroupUsers。

名称 类型 描述
UserUin String 用户 UIN
示例值:100012345678
UserName String 用户名
示例值:user_name
Nickname String 昵称
示例值:小明
CreateTime String 创建时间
示例值:2025-01-01 00:00:00
UpdateTime String 更新时间
示例值:2025-01-01 00:00:00

ConsoleRoleInfo

控制台角色信息(对外标准版,与内部 Role 解耦)

被如下接口引用:ListConsoleRoles。

名称 类型 描述
BasicInfo RoleBasicInfo 角色基本信息
注意:此字段可能返回 null,表示取不到有效值。
MetaData RoleMetaData 角色元信息
注意:此字段可能返回 null,表示取不到有效值。
Permissions Array of RolePermission 角色权限
注意:此字段可能返回 null,表示取不到有效值。

ConsoleUserInfo

控制台用户信息(规范化,与内部 UserDetailInfo 解耦)

被如下接口引用:ListConsoleUsers。

名称 类型 描述
UserUin String 用户 UIN
示例值:100012345678
UserName String 用户名
示例值:user_name
Nickname String 昵称
示例值:小明
Roles Array of RoleBasicInfo 角色列表
注意:此字段可能返回 null,表示取不到有效值。
UserSource String 用户来源,group:用户组、user:用户
示例值:user
CreateTime String 创建时间
示例值:2025-01-01 00:00:00
UpdateTime String 更新时间
示例值:2025-01-01 00:00:00
IsOwner Boolean 是否主账号
示例值:true
UserTag Integer 0: 普通用户 1: entraId用户
示例值:0
IsAdmin Boolean 是否具有 admin 权限的子账号
示例值:true

CreateConsoleGroupRsp

创建控制台用户组响应

被如下接口引用:CreateConsoleGroup。

名称 类型 描述
GroupId String 创建成功的用户组 ID
示例值:17676143448574812

CreateFolderRsp

创建文件夹回包

被如下接口引用:CreateFolder。

名称 类型 必选 描述
FolderId String 否

文件夹 ID


示例值:872499382026919936

CreateWorkflowRsp

CreateWorkflowRsp

被如下接口引用:CreateWorkflow。

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

CreateWorkspaceRsp

创建工作空间响应

被如下接口引用:CreateWorkspace。

名称 类型 必选 描述
WorkspaceId String 否 创建成功的工作空间ID
示例值:17676143448574812

DeleteConsoleGroupsRsp

删除控制台用户组响应

被如下接口引用:DeleteConsoleGroups。

名称 类型 描述
Status Boolean 操作是否成功
示例值:true

DeleteFileResult

文件删除结果

被如下接口引用:DeleteFile。

名称 类型 必选 描述
FileId String 否

被删除的文件 ID


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

删除是否成功


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

DeleteFolderRsp

删除文件夹回包

被如下接口引用:DeleteFolder。

名称 类型 必选 描述
Status Boolean 否

删除文件夹状态


示例值:true

DeleteWorkflowRsp

DeleteWorkflowRsp

被如下接口引用:DeleteWorkflow。

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

DeleteWorkspaceRsp

删除工作空间响应

被如下接口引用:DeleteWorkspace。

名称 类型 必选 描述
Status Boolean 否 操作是否成功
示例值:true

DependOnBrief

任务依赖简要信息

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

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

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,表示取不到有效值。

FileMeta

文件元数据

被如下接口引用:GetFolder, ListFiles。

名称 类型 必选 描述
FileId String 否

文件id


示例值:135
FileName String 否

文件/文件夹名称


示例值:acf
FileType String 否

文件类型


示例值:FILE
CreateTime String 否

创建时间,毫秒秒级时间戳

参数格式:时间戳


示例值:1779954222000
UpdateTime String 否

更新时间

参数格式:时间戳字符串


示例值:1779954222000
AllowActions Array of String 否

acl权限类型


示例值:["MANAGE"]
IsFavorite Boolean 否

是否收藏


示例值:false
PathName String 否

文件path


示例值:/Workspace/Users/we*v@***.co***246/new-folder
IsSystemGenerated Boolean 否

是否系统创建


示例值:false

FileNode

文件节点

被如下接口引用:GetFolder, ListFiles。

名称 类型 必选 描述
Node FileMeta 否

当前节点

Parent FileMeta 否

父节点

Creator UserInfo 否

创建人

Owner UserInfo 否

拥有者

NodeType String 否

节点类型


示例值:“ROOT”
OriginPath String 否

原始路径


示例值:/a/b/c
DeleteTime String 否

回收时间


示例值:“1766631841”
GitConfig GitRepoConfig 否

文件git配置


注意:此字段可能返回 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"

FolderLocator

文件夹定位器

被如下接口引用:CreateFolder, DeleteFolder, GetFolder, ListFiles, UpdateFolder。

名称 类型 必选 描述
FolderId String 否

节点id


示例值:847862709978656768
PathName String 否

节点path


示例值:/Workspace/Users/weda*-@te*nco**0**8/folder1

GetFolderRsp

获取文件夹回包

被如下接口引用:GetFolder。

名称 类型 必选 描述
Folder FileNode 否

文件夹信息

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,表示取不到有效值。
示例值:{"bundle_key": "bundle_value"}
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,表示取不到有效值。
示例值:py_0807
WorkflowTaskRunId String 否

任务运行ID


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

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


注意:此字段可能返回 null,表示取不到有效值。
示例值:RUNNING
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 否

任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述


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

任务版本ID


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

触发类型

枚举值:

  • Scheduler: 调度触发
  • Manual: 手动触发

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

所属资源组ID


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

错误码


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

运行用户UIN


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

运行用户名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:wedat**st*n****m
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,表示取不到有效值。
示例值:3600
WaitTime String 否

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


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

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


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

时区


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

依赖上游任务ID列表。保留字段,暂时返回为[]

保留字段,暂时返回为[]


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

运行参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"loopDataArrayExpr":"[1,2]","loopDataArrayResolved":"[1,2]","maxConcurrency":"1"}
TaskTypeExtensions String 否

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


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"TaskTypeName":"PYTHON","Notebook":null,"TaskTypePropertyList":[{"PropertyKey":"Source","PropertyValue":"5"},{"PropertyKey":"SourcePath","PropertyValue":"/Workspace/test.py"}]}
LeftCoordinate Float 否

任务X坐标


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

任务Y坐标


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

重试次数


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

工作流名称


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

重跑次数


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

是否最新一次运行


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

资源组信息列表


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

错误消息


注意:此字段可能返回 null,表示取不到有效值。
示例值:Execution failed. Please check the driver and executor logs.
RunResult String 否

运行结果


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"TotalIterations":3, "MaxConcurrency":3, "LoopDataArray":"[1, 2, 3]", "State":"SUCCESS", "IterationInstanceIds":["111_iter_1", "111_iter_2", "111_iter_3"]}
InnerWorkflowTaskRun InnerWorkflowTaskRun 否

内嵌工作流任务运行详情(仅限 FOR_EACH 任务,其他任务类型不返回该字段)


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

计划调度时间

参数格式:毫秒时间戳(UTC)


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

GetWorkspaceRsp

查询工作空间详情响应

被如下接口引用:GetWorkspace。

名称 类型 必选 描述
WorkspaceInfo WorkspaceInfo 否 工作空间详情

GitRepoConfig

git配置

被如下接口引用:CreateFolder, GetFolder, ListFiles。

名称 类型 必选 描述
SparseCheckout SparseCheckoutConfig 否

检出规则


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

Git 仓库地址


示例值:https://github.com/Doble-creater/test
Branch String 否

分支名


示例值:main
AuthConfigName String 否

关联的 gitAuth 配置名称


示例值:17884219514893801

InnerWorkflowTaskBrief

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

被如下接口引用:ListWorkflowTaskRuns。

名称 类型 必选 描述
TaskId String 否 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a4dfb8d2-cc55-4a24-8573-0091b791a927
TaskName String 否 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:py_0807
TaskTypeName String 否 任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:PYTHON

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,表示取不到有效值。
示例值:{"pppp1":"vvvv1"}
ErrorCodeString String 否

错误码


注意:此字段可能返回 null,表示取不到有效值。
示例值:TaskExecuteFailed
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,表示取不到有效值。
示例值:{"loopDataArray":"[1,2,3]"}
ErrorCodeString String 否

错误码


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

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

ListConsoleGroupUsersRsp

查询控制台用户组成员列表响应

被如下接口引用:ListConsoleGroupUsers。

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

ListConsoleGroupsRsp

查询控制台用户组列表响应

被如下接口引用:ListConsoleGroups。

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

ListConsoleRolesRsp

查询控制台角色列表响应

被如下接口引用:ListConsoleRoles。

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

ListConsoleUsersRsp

查询控制台用户列表响应

被如下接口引用:ListConsoleUsers。

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

ListFilesRsp

查询文件信息结果

被如下接口引用:ListFiles。

名称 类型 描述
Items Array of FileNode

文件/文件夹节点列表

PageNumber Integer

当前页码


示例值:1
PageSize Integer

每页条数


示例值:10
TotalCount Integer

总条数


示例值:2
TotalPageNumber Integer

总页数


示例值:1

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。

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

OrderBy

排序字段

被如下接口引用:ListConsoleGroupUsers, ListConsoleGroups, ListConsoleUsers, ListFiles, 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

RemoveConsoleUsersRsp

批量移除控制台用户响应

被如下接口引用:RemoveConsoleUsers。

名称 类型 描述
Status Boolean

请求已完成处理;即使部分失败也为 true,逐个结果以 SuccessUins/FailItems 为准


示例值:true
SuccessUins Array of String

删除成功的用户 UIN 列表


示例值:["10001"]
FailItems Array of CommonFailItem

失败项列表(Item 为用户 UIN,FailReason 为失败原因)

ResourceGroupInfo

资源组信息

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

名称 类型 必选 描述
ResourceGroupId String 否

资源组ID


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

资源组名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:ray计算资源
ResourceGroupStatus String 否

资源组状态

参数格式:0 // 未指定 1 // 待创建 2 // 创建中 3 // 运行中 4 // 已停止 5 // 停止中 6 // 启动中 7 // 更新中 8 // 删除中 9 // 已删除 10 // 用户主动启动 / 自动启动(有任务提交且自动启停开启) 11 // 可用: 仅存在于数据计算型 12 // 不可用: 仅存在于数据计算型 13 // 失败


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

RoleBasicInfo

角色基础信息

被如下接口引用:ListConsoleGroups, ListConsoleRoles, ListConsoleUsers。

名称 类型 必选 描述
Id String 否

角色ID


示例值:17676143448574812
Name String 否

角色名称


示例值:admin
Description String 否

角色描述


示例值:这是描述信息
DisplayName String 否

显示名称


示例值:管理员
RoleType String 否

角色类型


示例值:default
Source Integer 否

角色来源,参考 web_enum_standard.proto -> RoleSource:0=未指定 1=用户直绑 2=用户组继承 3=两者都有


示例值:1
GroupNames Array of String 否

继承来源的用户组名称列表,Source=1 时为空


示例值:["example1"]

RoleMetaData

角色元数据

被如下接口引用:ListConsoleRoles。

名称 类型 描述
Creator String 创建者
示例值:creator_user
CreateTime String 创建时间
示例值:2025-01-01 00:00:00
Updater String 更新者
示例值:updater_user
UpdateTime String 更新时间
示例值:2025-01-01 00:00:00

RolePermission

角色权限

被如下接口引用:ListConsoleRoles。

名称 类型 必选 描述
ModuleId String 否 模块ID
示例值:17676143448574812
Permissions String 否 权限点
示例值:READ,WRITE

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,表示取不到有效值。
示例值:Execution failed. Please check the driver and executor logs.
OpStatus Boolean 否 操作状态,true 表示成功,false 表示失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
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

ScheduledTimeConfig

计划调度时间配置

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

名称 类型 必选 描述
ScheduledTimeZone String 否

调度时区,IANA 时区 ID


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

调度生效开始时间

参数格式:毫秒时间戳(UTC)


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

调度生效结束时间

参数格式:毫秒时间戳(UTC)


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

周期类型

枚举值:

  • DAY_CYCLE: 天
  • HOUR_CYCLE: 小时
  • MINUTE_CYCLE: 分钟
  • WEEK_CYCLE: 周

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

周期步长


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

SparseCheckoutConfig

git检出规则

被如下接口引用:CreateFolder。

名称 类型 必选 描述
Enabled Boolean 否

是否启用稀疏检出


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

是否使用 cone 模式(推荐 true,按目录匹配更高效)


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

稀疏检出路径列表(如 ["src/module-a/", "docs/"])


注意:此字段可能返回 null,表示取不到有效值。
示例值:["src/module-a/", "docs/"]

StandardUserInfo

用户基础展示信息

被如下接口引用:GetWorkspace。

名称 类型 必选 描述
UserUin String 否 用户UIN
示例值:100044134096
UserName String 否 用户名
示例值:sub-user-01
Nickname String 否 昵称
示例值:sub-user-01
UserTag String 否 0: 普通用户 1: entraId用户
示例值:0

TaskRetryStrategy

任务重试策略

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

名称 类型 必选 描述
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。

名称 类型 必选 描述
UpstreamTaskId String 否

上游任务ID


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

上游任务名称


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

任务可运行条件
支持的状态值: - SUCCESS: 成功 - FAILED: 失败 - UPSTREAM_FAILED: 上游失败 - EXCLUDED: 排除运行


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

TaskSchedulingParameterBrief

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

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

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

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。

名称 类型 必选 描述
TaskTypeName String 否

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


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

Notebook 类型扩展信息


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

任务类型属性列表,不同任务类型所需的 PropertyKey 不同,具体取值请参考 ListWorkflowTaskTypeProperties 接口返回


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

运行时属性列表


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

TaskTypeNotebookExt

Notebook 类型任务扩展

被如下接口引用:CreateWorkflow。

名称 类型 必选 描述
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,表示取不到有效值。
示例值:/notebook_task.ipynb
NotebookPath String 否

Notebook 相对路径


注意:此字段可能返回 null,表示取不到有效值。
示例值:/Workspace/notebook_task.ipynb
NotebookAbsolutePath String 否

Notebook 绝对路径


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

TaskTypeProperty

任务类型属性键值对

被如下接口引用:CreateWorkflow。

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

UnbindWorkflowBundleRsp

UnbindWorkflowBundleRsp

被如下接口引用:UnbindWorkflowBundle。

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

UpdateConsoleGroupRsp

修改控制台用户组响应

被如下接口引用:UpdateConsoleGroup。

名称 类型 描述
Status Boolean 操作是否成功
示例值:true

UpdateConsoleUsersRsp

修改控制台用户响应

被如下接口引用:UpdateConsoleUsers。

名称 类型 描述
Status Boolean 操作是否成功
示例值:true

UpdateFolderRsp

更新文件夹回包

被如下接口引用:UpdateFolder。

名称 类型 必选 描述
Status Boolean 否

更新文件夹结果,true为成功


示例值:true

UpdateWorkflowRsp

UpdateWorkflowRsp

被如下接口引用:UpdateWorkflow。

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

UpdateWorkspaceRsp

修改工作空间响应

被如下接口引用:UpdateWorkspace。

名称 类型 必选 描述
Status Boolean 否 操作是否成功
示例值:true

UserInfo

用户基本信息

被如下接口引用:GetFolder, ListFiles。

名称 类型 必选 描述
UserUin String 否

uin


示例值:700002267912
UserName String 否

子用户名称


示例值:wedata30-test1@tencent.com
Nickname String 否

子用户昵称


示例值:wedata30-test1@tencent.com
UserTag String 否

0: 普通用户 1: entraId用户


示例值:0

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,表示取不到有效值。
示例值:{"bundle_name":"test_bj","bundle_path":"/Workspace/Users/gaohan@100048098877/.bundle/test_bj/dev/files/resources/workflow/sql_workflow.yml"}
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,表示取不到有效值。
示例值:tom
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,表示取不到有效值。
示例值:tom
OwnerUserUin String 否 工作流负责人UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100044134096
OwnerDisplayName String 否 工作流负责人展示名
注意:此字段可能返回 null,表示取不到有效值。
示例值:Tom Zhang
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,表示取不到有效值。
示例值:tom
OwnerUserUin String 否

工作流负责人UIN


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

工作流负责人展示名


注意:此字段可能返回 null,表示取不到有效值。
示例值:Tom Zhang
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,表示取不到有效值。
示例值:tom
TaskList Array of WorkflowTaskNodeBrief 否

工作流任务节点列表


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

工作流运行情况列表


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

资源组信息列表


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

授权权限类型
PERMISSION_TYPE_UNSPECIFIED:未指定权限
MANAGE : 管理权限:包含所有操作权限
RUN : 运行权限:可执行实体
VIEW : 查看权限:可查看实体内容


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

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


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

Bundle信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"bundle_name":"test_git","bundle_path":"/Workspace/Users/700002164619/.bundle/test_git/prod/files/resources/workflow/zl_git_wf_260901.yml"}
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,表示取不到有效值。
示例值:bonney_test
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,表示取不到有效值。
示例值:Scheduler
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,表示取不到有效值。
示例值:3600
QueueCostTime String 否

并发排队花费时间,单位:秒


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

等待资源花费时间,单位:秒


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

运行状态。CREATE("初始化"), QUEUED("等待中"), PENDING("准备中"), RUNNING("运行中"), SKIPPED("跳过运行"), SUCCESS("成功"), FAILED("失败"), TERMINATING("终止中"), TERMINATED("终止"), CANCELLED("被手动终止")等


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

计算资源(任务的资源组ID集合)


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

运行用户UIN


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

运行用户名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:wea**st1@*nt.com
ErrorCodeString String 否

错误码


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

运行参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"pppp1":"vvvv1"}
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,表示取不到有效值。
示例值:dwd_task
Permission String 否

授权权限类型
PERMISSION_TYPE_UNSPECIFIED:未指定权限
MANAGE : 管理权限:包含所有操作权限
RUN : 运行权限:可执行实体
VIEW : 查看权限:可查看实体内容


注意:此字段可能返回 null,表示取不到有效值。
示例值:MANAGE
AdvancedParameters Array of AdvancedParameter 否

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


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

计划调度时间

参数格式:毫秒时间戳(UTC)


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

WorkflowRunBrief

工作流列表项的运行情况

被如下接口引用:ListWorkflows。

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

运行状态。CREATE("初始化"), QUEUED("等待中"), PENDING("准备中"), RUNNING("运行中"), SKIPPED("跳过运行"), SUCCESS("成功"), FAILED("失败"), TERMINATING("终止中"), TERMINATED("终止"), CANCELLED("被手动终止")等


注意:此字段可能返回 null,表示取不到有效值。
示例值:RUNNING
ErrorCodeString String 否 运行错误码
注意:此字段可能返回 null,表示取不到有效值。
示例值:TaskExecuteFailed

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,表示取不到有效值。
示例值:py_0807
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,表示取不到有效值。
示例值:ALL_SUCCESS
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,表示取不到有效值。
示例值:py_0807
TaskTypeName String 否

任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:PYTHON
DependOnList Array of DependOnBrief 否

任务依赖列表


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

任务资源组ID


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

任务资源组名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:作业集群-计算型-16cu
LeftCoordinate Float 否

任务X坐标


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

任务Y坐标


注意:此字段可能返回 null,表示取不到有效值。
示例值:50
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,表示取不到有效值。
示例值:ALL_SUCCESS
AdvancedDependencyConfig AdvancedDependencyConfig 否

高级依赖配置


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

内嵌工作流任务节点


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

WorkflowTaskRun

工作流任务运行信息

被如下接口引用:ListWorkflowTaskRuns。

名称 类型 必选 描述
TaskName String 否

任务名称


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

任务运行ID


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

运行状态。如CREATE("初始化"), QUEUED("等待中"), PENDING("准备中"), RUNNING("运行中"), SKIPPED("跳过运行"), SUCCESS("成功"), FAILED("失败"), TERMINATING("终止中"), TERMINATED("终止"), CANCELLED("被手动终止")等


注意:此字段可能返回 null,表示取不到有效值。
示例值:RUNNING
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 否

任务类型名称,请参考数据结构TaskType中TaskTypeName字段描述


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

任务版本ID


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

触发类型

枚举值:

  • Manual: 手动触发
  • Scheduler: 调度触发

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

所属资源组ID


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

错误码


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

运行用户UIN


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

运行用户名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:tom
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,表示取不到有效值。
示例值:3600
WaitTime String 否

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


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

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


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

时区


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

依赖上游任务ID列表。保留字段,暂时返回为[]

保留字段,暂时返回为[]


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

运行参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"pt1":"1"}
TaskTypeExtensions String 否

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


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"TaskTypeName":"PYTHON","Notebook":null,"TaskTypePropertyList":[{"PropertyKey":"Source","PropertyValue":"5"},{"PropertyKey":"SourcePath","PropertyValue":"/Workspace/test.py"}]}
LeftCoordinate Float 否

任务X坐标


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

任务Y坐标


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

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


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

工作流名称


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

重跑次数


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

是否最新一次运行


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

资源组信息列表


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

运行结果


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ConditionResults":[], "AllowedDownstreamTaskIds":[], "ExcludedDownstreamTaskIds":[], "State":"FAILED", "ErrorMessage":"parse if-else result failed: empty param_json", "ScriptFileId":"877523637043445760"}
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,表示取不到有效值。
示例值:ALL_SUCCESS
AdvancedDependencyConfig AdvancedDependencyConfig 否

高级依赖配置


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

内嵌工作流任务信息


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

计划调度时间

参数格式:毫秒时间戳,UTC


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

WorkflowTriggerAdvancedConfiguration

工作流调度高级配置。

被如下接口引用:CreateWorkflow。

名称 类型 必选 描述
TaskRetryMode String 否

<p>该工作流下的所有任务重试模式,仅当TriggerMode为CONTINUE_RUN时有效。

枚举值:

  • onFailure: 失败时自动重试
  • never: 从不重试

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

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,表示取不到有效值。
示例值:{"taskAction":"1"}
AdvancedConfig WorkflowTriggerAdvancedConfiguration 否

高级配置


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

WorkspaceInfo

工作空间信息

被如下接口引用:GetWorkspace。

名称 类型 必选 描述
WorkspaceId String 否 工作空间ID
示例值:17676143448574812
WorkspaceName String 否 工作空间名称
示例值:my_workspace
Description String 否 工作空间描述
示例值:这是描述信息
WorkspaceRegion String 否 工作空间地域(如 ap-guangzhou)
示例值:ap-guangzhou
Status Integer 否 工作空间状态:0=未指定 1=创建中 2=创建失败 3=正常运行中 4=已删除
示例值:3
ErrorReason String 否 失败原因(Status=2 创建失败时有值)
示例值:权限不足
Creator StandardUserInfo 否 创建者信息
CreateTime String 否 创建时间,毫秒时间戳
示例值:1735689600000
UpdateTime String 否 更新时间,毫秒时间戳
示例值:1735689600000
HasAccess Boolean 否 当前用户是否拥有该工作空间的访问权限
示例值:true