数据结构

最近更新时间:2026-01-09 03:50:57

我的收藏

AlarmGroup

告警规则接收人配置

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
AlarmEscalationRecipientIds Array of String 告警升级人ID列表
若告警接收人或上级升级人未在告警间隔时间内确认告警,则会发送告警给下一级升级人。
AlarmEscalationInterval Integer 告警升级间隔
NotificationFatigue NotificationFatigue 告警通知疲劳配置
AlarmWays Array of String 告警渠道 1.邮件,2.短信,3.微信,4.语音,5.企业微信,6.Http,7.企业微信群 8 飞书群 9 钉钉群 10 Slack群 11 Teams群(默认1.邮件) 7.企业微信群 8 飞书群 9 钉钉群 10 Slack群 11 Teams群 只能选择一个渠道
WebHooks Array of AlarmWayWebHook 企业微信群/飞书群/钉钉群 /Slack群/Teams群的webhook地址列表
AlarmRecipientType Integer 告警接收人类型:1.指定人员,2.任务责任人,3.值班表(默认1.指定人员)
AlarmRecipientIds Array of String 根据AlarmRecipientType的类型该列表具有不同的业务id 1(指定人员): 告警接收人id列表 2(任务责任人):无需配置 3(值班表):值班表id列表

AlarmMessage

告警信息

被如下接口引用:GetAlarmMessage, ListAlarmMessages。

名称 类型 描述
AlarmMessageId Integer 告警消息Id
示例值:115987
AlarmTime String 告警时间,同一条告警可能发送多次,只显示最新的告警时间
示例值:2025-08-07 16:00:00
TaskName String 任务名称
示例值:succ_task1
TaskId String 任务Id
示例值:20250326112047650
CurRunDate String 任务的实例数据时间
示例值:2025-09-08 15:00:00
AlarmReason String 告警原因
示例值:4
AlarmLevel Integer 告警级别,1.普通, 2.重要,3.紧急
示例值:1
AlarmRuleId String 告警规则Id
示例值:51d5c5f0-c88a-4c4a-ba0f-4175af27ad96
AlarmWays Array of String 告警渠道 1.邮件,2.短信,3.微信,4.语音,5.企业微信,6.Http,7.企业微信群, 8.飞书群,9.钉钉群,10.Slack群,11.Teams群(默认1.邮件),7.企业微信群,8.飞书群,9.钉钉群,10.Slack群,11.Teams群
示例值:["email","sms"]
AlarmRecipients Array of String 告警接收人
示例值:["mytestdd"]

AlarmQuietInterval

告警免打扰时间区间

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
DaysOfWeek Array of Integer ISO标准,1表示周一,7表示周日。
示例值:[1, 2]
StartTime String 开始时间,精度时分秒,格式 HH:mm:ss
示例值:01:01:01
EndTime String 结束时间,精度时分秒,格式 HH:mm:ss
示例值:02:01:01

AlarmRuleData

告警规则详情

被如下接口引用:GetOpsAlarmRule, ListOpsAlarmRules。

名称 类型 描述
AlarmRuleId String 告警规则id
示例值:5466614e****a681e5a
AlarmRuleName String 告警规则名称
示例值:RuleName
Description String 告警规则描述
示例值:this is description
MonitorObjectType Integer 监控对象类型,
任务维度监控: 可按照任务/工作流/项目来配置:1.任务、2.工作流、3.项目(默认为1.任务)
项目维度监控: 项目整体任务波动告警, 7:项目波动监控告警
MonitorObjectIds Array of String 根据MonitorType 的设置传入不同的业务id,如下1(任务): MonitorObjectIds为任务id列表2(工作流): MonitorObjectIds 为工作流id列表(工作流id可从接口ListWorkflows获取)3(项目): MonitorObjectIds为项目id列表
示例值:["2023***597"]
AlarmTypes Array of String 告警规则监控类型
failure:失败告警 ;overtime:超时告警 success:成功告警; backTrackingOrRerunSuccess: 补录重跑成功告警 backTrackingOrRerunFailure:补录重跑失败告警;
项目波动告警
projectFailureInstanceUpwardFluctuationAlarm: 当天失败实例数向上波动率超过阀值告警;
projectSuccessInstanceDownwardFluctuationAlarm:当天成功实例数向下波动率超过阀值告警;

离线集成任务对账告警:
reconciliationFailure: 离线对账任务失败告警
reconciliationOvertime: 离线对账任务运行超时告警
reconciliationMismatch: 数据对账任务不一致条数超过阀值告警

示例值:["failure"]
Status Integer 告警规则是否启用
0-- 禁用 1--启用
示例值:0
AlarmRuleDetail AlarmRuleDetail 告警规则配置信息 成功告警无需配置;失败告警可以配置首次失败告警或者所有重试失败告警;超时配置需要配置超时类型及超时阀值;项目波动告警需要配置波动率及防抖周期配置
AlarmLevel Integer 告警级别 1.普通、2.重要、3.紧急
示例值:1
OwnerUin String 告警规则创建人uid
BundleId String bundle 客户端绑定的告警规则: 为空是正常的告警规则,不为空则是对应bundle客户端绑定的规则
注意:此字段可能返回 null,表示取不到有效值。
BundleInfo String bundleId不为空 则表示绑定的bundle客户端名称
注意:此字段可能返回 null,表示取不到有效值。
AlarmGroups Array of AlarmGroup 告警接收人配置列表

AlarmRuleDetail

告警规则详细配置

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
Trigger Integer 失败触发时机 

1 – 首次失败触发
2 --所有重试完成触发 (默认)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DataBackfillOrRerunTrigger Integer 补录重跑触发时机

1 –  首次失败触发
2 – 所有重试完成触发
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TimeOutExtInfo Array of TimeOutStrategyInfo 周期实例超时配置明细
注意:此字段可能返回 null,表示取不到有效值。
DataBackfillOrRerunTimeOutExtInfo Array of TimeOutStrategyInfo 重跑补录实例超时配置明细
注意:此字段可能返回 null,表示取不到有效值。
ProjectInstanceStatisticsAlarmInfoList Array of ProjectInstanceStatisticsAlarmInfo 项目波动告警配置明细
注意:此字段可能返回 null,表示取不到有效值。
ReconciliationExtInfo Array of ReconciliationStrategyInfo 离线集成对账告警配置信息
注意:此字段可能返回 null,表示取不到有效值。
MonitorWhiteTasks Array of MonitorWhiteTask 监控对象的白名单配置
WorkflowCompletionTimeCycleExtInfo Array of TimeOutStrategyInfo 3.0 Workflow 完成时间(周期)告警策略
注意:此字段可能返回 null,表示取不到有效值。
WorkflowExecutionTrigger Integer 工作流执行触发告警条件
注意:此字段可能返回 null,表示取不到有效值。
WorkflowExecutionFailureTrigger Integer 工作流执行失败告警条件
注意:此字段可能返回 null,表示取不到有效值。
WorkflowExecutionSuccessTrigger Integer 工作流执行成功告警条件
注意:此字段可能返回 null,表示取不到有效值。

AlarmWayWebHook

告警渠道 企业微信群/钉钉群/飞书群 等webhook地址配置

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
AlarmWay String 告警渠道值
7.企业微信群,8 飞书群 9 钉钉群 10 Slack群 11 Teams群
示例值:7
WebHooks Array of String 告警群的webhook地址列表
示例值:["https://open****"]

AuthInfo

权限用户项目信息

被如下接口引用:DescribeDataSourceAuthority。

名称 类型 描述
AuthProjectIds Array of String 授权给的目标项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:["234234","324354"]
AuthUsers Array of String 授权给的项目下用户列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["32535_32432"]

BackfillInstance

单次补录实例详情

被如下接口引用:ListDataBackfillInstances。

名称 类型 描述
TaskName String 任务名称
示例值:replenishment_test
TaskId String 任务Id
示例值:20250807170933305
CurRunDate String 实例数据时间
示例值:2025-08-07 15:40:00
State String 执行状态
示例值:COMPLETED
StartTime String 开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-07 15:46:04
EndTime String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-07 15:52:09
CostTime String 执行时长
注意:此字段可能返回 null,表示取不到有效值。
示例值:00:06:05.000

BackfillInstanceCollection

补录计划的所有实例

被如下接口引用:ListDataBackfillInstances。

名称 类型 描述
PageNumber Integer 分页页码
PageSize Integer 分页大小
TotalPageNumber Integer 总页数
TotalCount Integer 记录总数
Items Array of BackfillInstance 补录实例列表

BatchOperationOpsDto

批量操作的结果返回

被如下接口引用:UpdateOpsTriggerTasksOwner。

名称 类型 描述
SuccessCount Integer 批量操作成功数
示例值:1
FailedCount Integer 批量操作失败数
示例值:0
TotalCount Integer 批量操作的总数
示例值:0
AsyncActionId String 异步操作记录的唯一id
示例值:111222

BindProject

关联绑定的project

被如下接口引用:ListResourceGroups。

名称 类型 描述
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250728105857482734
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test1
ProjectDisplayName String 项目展示名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test1

BizStateEnumInfoBrief

工作流执行的业务枚举信息

被如下接口引用:GetTriggerWorkflowRun。

名称 类型 描述
LabelKey String 标签key
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
LabelValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。
示例值:成功
Count Integer 标签总数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

BriefTask

展示任务id和任务名称信息

被如下接口引用:GetDataSourceRelatedTasks。

名称 类型 描述
TaskId String 任务id
注意:此字段可能返回 null,表示取不到有效值。
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 任务创建时间
注意:此字段可能返回 null,表示取不到有效值。
OwnerUinList Array of String 任务责任人id,一个任务可能有多个责任人
注意:此字段可能返回 null,表示取不到有效值。

BusinessMetadata

BusinessMetadata

被如下接口引用:GetTable, ListTable。

名称 类型 必选 描述
TagNames Array of String 标签名称
注意:此字段可能返回 null,表示取不到有效值。

CatalogInfo

目录信息

被如下接口引用:ListCatalog。

名称 类型 必选 描述
Name String 目录名称

ChildDependencyConfigPage

任务下游依赖详情分页

被如下接口引用:ListDownstreamOpsTasks。

名称 类型 描述
TotalCount Integer 结果总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of OpsTaskDepend 分页数据
注意:此字段可能返回 null,表示取不到有效值。

CodeFile

数据探索脚本业务处理实体

被如下接口引用:CreateCodeFile, GetCodeFile, UpdateCodeFile。

名称 类型 描述
CodeFileId String 脚本ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:41da32a9-865d-42a8-93c0-3cf205c66190
CodeFileName String 脚本名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:数据工程师.bat
OwnerUin String 脚本所有者 uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:100041136799
CodeFileConfig CodeFileConfig 脚本配置
注意:此字段可能返回 null,表示取不到有效值。
CodeFileContent String 脚本内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"name":"1234"}
UpdateUserUin String 最近一次操作人
注意:此字段可能返回 null,表示取不到有效值。
示例值:100041136799
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1464962169590902784
UpdateTime String 更新时间 yyyy-MM-dd hh:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-09-18 18:29:13
CreateTime String 创建时间 yyyy-MM-dd hh:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-09-17 19:26:30
AccessScope String 权限范围:SHARED, PRIVATE
注意:此字段可能返回 null,表示取不到有效值。
示例值:SHARED
Path String 节点全路径,/aaa/bbb/ccc.ipynb,由各个节点的名称组成
注意:此字段可能返回 null,表示取不到有效值。
示例值:/mereditest/batfile/数据工程师.bat
ParentFolderPath String 父文件夹路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/aaa/bbb/ccc

CodeFileConfig

数据探索脚本配置

被如下接口引用:CreateCodeFile, GetCodeFile, UpdateCodeFile。

名称 类型 必选 描述
Params String 高级运行参数,变量替换,map-json String,String
注意:此字段可能返回 null,表示取不到有效值。
NotebookSessionInfo NotebookSessionInfo notebook kernel session信息
注意:此字段可能返回 null,表示取不到有效值。

CodeFolderNode

数据探索脚本文件树节点

被如下接口引用:GetCodeFolder, ListCodeFolderContents。

名称 类型 描述
Id String 唯一标识
示例值:d5226c07-d079-448b-8262-7dd2a882d3f6
Title String 名称
示例值:test2
Type String 类型 folder,script
示例值:folder
IsLeaf Boolean 是否叶子节点
示例值:true
Params String 业务参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:'{"afd":"cwe"}'
AccessScope String 权限范围: SHARED, PRIVATE
注意:此字段可能返回 null,表示取不到有效值。
示例值:SHARED
Path String 节点路径
示例值:/000112x_10121/111.ipynb
OwnerUin String 目录/文件责任人uin
示例值:100041136802
CreateUserUin String 创建人
示例值:100028650795
NodePermission String 当前用户对节点拥有的权限
注意:此字段可能返回 null,表示取不到有效值。
示例值:CAN_MANAGE
Children Array of CodeFolderNode 子节点列表
注意:此字段可能返回 null,表示取不到有效值。
ParentFolderPath String 父文件夹路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/aaa/bbb/ccc

CodePermissionsResultItem

数据探索文件授权结果

被如下接口引用:CreateCodePermissions, DeleteCodePermissions。

名称 类型 必选 描述
Item String 资源id
注意:此字段可能返回 null,表示取不到有效值。
Result Boolean 该资源权限操作是否成功
注意:此字段可能返回 null,表示取不到有效值。
Reason String 若是创建失败, 提供失败原因
注意:此字段可能返回 null,表示取不到有效值。

CodeStudioFileActionResult

CodeStudio文件对象操作结果

被如下接口引用:DeleteCodeFile。

名称 类型 描述
Status Boolean 成功true,失败false
注意:此字段可能返回 null,表示取不到有效值。
CodeFileId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。

CodeStudioFolderActionResult

CodeStudio文件夹对象操作结果

被如下接口引用:DeleteCodeFolder, UpdateCodeFolder。

名称 类型 描述
Status Boolean 成功true,失败false
注意:此字段可能返回 null,表示取不到有效值。
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。

CodeStudioFolderResult

CodeStudio文件夹对象操作结果

被如下接口引用:CreateCodeFolder。

名称 类型 描述
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。

CodeStudioMaxPermission

用户对CodeStudio文件/文件夹的递归最大权限类型

被如下接口引用:GetMyCodeMaxPermission。

名称 类型 描述
PermissionType String 授权权限类型(CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE)
注意:此字段可能返回 null,表示取不到有效值。
示例值:CAN_MANAGE

ColumnInfo

ColumnInfo

被如下接口引用:GetTableColumns。

名称 类型 必选 描述
Type String 字段类型
注意:此字段可能返回 null,表示取不到有效值。
Name String 字段名称
Length Integer 字段长度
注意:此字段可能返回 null,表示取不到有效值。
Description String 字段描述
注意:此字段可能返回 null,表示取不到有效值。
Position Integer 字段的顺序
注意:此字段可能返回 null,表示取不到有效值。
IsPartition Boolean 是否为分区字段
注意:此字段可能返回 null,表示取不到有效值。

CommonQualityOperateResult

单条规则操作结果

被如下接口引用:DeleteQualityRuleGroup。

名称 类型 描述
Id Integer id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testName
Msg String 文案提示
注意:此字段可能返回 null,表示取不到有效值。
示例值:testMsg
Success Boolean 操作是否成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

CompareQualityResult

质量检查对比结果

被如下接口引用:ListQualityRuleGroupExecResultsByPage。

名称 类型 必选 描述
Items Array of CompareQualityResultItem 对比结果项列表
注意:此字段可能返回 null,表示取不到有效值。
TotalRows Integer 检测总行数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PassRows Integer 检测通过行数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TriggerRows Integer 检测不通过行数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ComputeExpression String 比较关系
注意:此字段可能返回 null,表示取不到有效值。
示例值:testExpressior

CompareQualityResultItem

对比结果项

被如下接口引用:ListQualityRuleGroupExecResultsByPage。

名称 类型 必选 描述
FixResult Integer 对比结果, 1为真 2为假
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ResultValue String 质量sql执行结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:testValue
Values Array of QualityThresholdValue 阈值列表
注意:此字段可能返回 null,表示取不到有效值。
Operator String 比较操作类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:creator
CompareType Integer 比较类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValueComputeType Integer 值比较类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

CreateAlarmRuleData

创建告警规则响应结果

被如下接口引用:CreateOpsAlarmRule。

名称 类型 描述
AlarmRuleId String 告警规则唯一id
示例值:b84aa****89f2de

CreateDataReplenishmentPlan

创建数据补录计划结果

被如下接口引用:CreateDataBackfillPlan。

名称 类型 描述
DataBackfillPlanId String 补录计划Id

CreateFolderResult

创建文件夹结果

被如下接口引用:CreateResourceFolder, CreateWorkflowFolder。

名称 类型 描述
FolderId String 创建成功的文件夹ID。如果创建失败则报错。

CreateProjectResult

创建项目的结果信息

被如下接口引用:CreateProject。

名称 类型 描述
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。

CreateQualityRuleGroupResultVO

监控任务

被如下接口引用:CreateQualityRuleGroup。

名称 类型 必选 描述
RuleGroupResultList Array of QualityRuleGroupResult 任务创建结构

CreateQualityRuleVO

数据质量规则批量创建结果

被如下接口引用:CreateQualityRule。

名称 类型 描述
Msg String 操作结果文案
注意:此字段可能返回 null,表示取不到有效值。
示例值:共配置1条规则,其中0条生成成功,1条生成失败
Results Array of QualityRuleCreateResult 单条数据新增结果对象
注意:此字段可能返回 null,表示取不到有效值。
SumCount Integer 总新增条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SuccessCount Integer 新增成功条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
FailedCount Integer 新增失败条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SuccessRuleIds Array of Integer 新增成功的 ruleId集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1001]

CreateResourceFileResult

创建资源文件结果

被如下接口引用:CreateResourceFile。

名称 类型 描述
ResourceId String 资源文件ID

CreateTaskBaseAttribute

创建任务基本属性信息

被如下接口引用:CreateTask。

名称 类型 必选 描述
TaskName String 任务名称
示例值:sh_api_250827_205043
TaskTypeId String 任务类型ID:

* 21:JDBC SQL
* 23:TDSQL-PostgreSQL
* 26:OfflineSynchronization
* 30:Python
* 31:PySpark
* 32:DLC SQL
* 33:Impala
* 34:Hive SQL
* 35:Shell
* 36:Spark SQL
* 38:Shell Form Mode
* 39:Spark
* 40:TCHouse-P
* 41:Kettle
* 42:Tchouse-X
* 43:TCHouse-X SQL
* 46:DLC Spark
* 47:TiOne
* 48:Trino
* 50:DLC PySpark
* 92:MapReduce
* 130:Branch Node
* 131:Merged Node
* 132:Notebook
* 133:SSH
* 134:StarRocks
* 137:For-each
* 138:Setats SQL
示例值:35
WorkflowId String 工作流ID
示例值:09cfab2c-8d4d-45e5-8af5-80b82f87ccb4
OwnerUin String 任务负责人ID,默认为当前用户
示例值:100028571357
TaskDescription String 任务描述
示例值:this is a shell task!
TaskFolderPath String 任务文件夹路径

注意:
- 路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
- 如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;

示例值:/tf_01

CreateTaskConfiguration

创建任务配置信息

被如下接口引用:CreateTask。

名称 类型 必选 描述
ResourceGroup String 资源组ID: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId
示例值:20240222212719833743
CodeContent String 代码内容的Base64编码
示例值:cHJpbnQoJ2hlbGxvIHdvcmxkIScp
TaskExtConfigurationList Array of TaskExtParameter 任务扩展属性配置列表
DataCluster String 集群ID
示例值:2568295b-56ac-4a74-8b37-4c8b17545353
BrokerIp String 指定的运行节点
示例值:any
YarnQueue String 资源池队列名称,需要通过 DescribeProjectClusterQueues 获取
示例值:default
SourceServiceId String 来源数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取
示例值:8444
TargetServiceId String 目标数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取
示例值:61933
TaskSchedulingParameterList Array of TaskSchedulingParameter 调度参数
BundleId String Bundle使用的ID
示例值:1
BundleInfo String Bundle信息
示例值:{"BundleName":"test", BundlePath:"/test"}

CreateTaskFolderResult

创建任务文件夹结果

被如下接口引用:CreateTaskFolder。

名称 类型 描述
TaskFolderId String 创建成功的文件夹ID。如果创建失败则报错。
示例值:bb220f80-1211-4e92-bf2b-2444011896cc

CreateTaskResult

创建任务返回体

被如下接口引用:CreateTask, CreateTriggerTask。

名称 类型 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250827172510504

CreateTaskSchedulerConfiguration

创建任务调度配置信息

被如下接口引用:CreateTask。

名称 类型 必选 描述
CycleType String 周期类型:默认为 DAY_CYCLE

支持的类型为

* ONEOFF_CYCLE: 一次性
* YEAR_CYCLE: 年
* MONTH_CYCLE: 月
* WEEK_CYCLE: 周
* DAY_CYCLE: 天
* HOUR_CYCLE: 小时
* MINUTE_CYCLE: 分钟
* CRONTAB_CYCLE: crontab表达式类型
示例值:DAY_CYCLE
ScheduleTimeZone String 时区,默认为 UTC+8
示例值:UTC+8
CrontabExpression String Cron表达式,默认为 0 0 0 * * ? *
示例值:0 0 0 * * ? *
StartTime String 生效日期,默认为当前日期的 00:00:00
示例值:2025-08-26 00:00:00
EndTime String 结束日期,默认为 2099-12-31 23:59:59
示例值:2099-12-31 23:59:59
ExecutionStartTime String 执行时间 左闭区间,默认 00:00
示例值:00:00
ExecutionEndTime String 执行时间 右闭区间,默认 23:59
示例值:23:59
CalendarOpen String 日历调度 取值为 0 和 1, 1为打开,0为关闭,默认为0
示例值:0
CalendarId String 日历调度 日历 ID
示例值:26
SelfDepend String 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序)
示例值:serial
UpstreamDependencyConfigList Array of DependencyTaskBrief 上游依赖数组
EventListenerList Array of EventListener 事件数组
AllowRedoType String 重跑&补录配置, 默认为 ALL; , ALL 运行成功或失败后皆可重跑或补录, FAILURE 运行成功后不可重跑或补录,运行失败后可重跑或补录, NONE 运行成功或失败后皆不可重跑或补录;
示例值:ALL
ParamTaskOutList Array of OutTaskParameter 输出参数数组
ParamTaskInList Array of InTaskParameter 输入参数数组
TaskOutputRegistryList Array of TaskDataRegistry 产出登记
InitStrategy String 实例生成策略
* T_PLUS_0: T+0生成,默认策略
* T_PLUS_1: T+1生成
示例值:T_PLUS_0
ScheduleType Integer 调度类型: 0 正常调度 1 空跑调度,默认为 0
示例值:0
RunPriorityType Integer 任务调度优先级 运行优先级 4高 5中 6低 , 默认:6
示例值:6
RetryWaitMinute Integer 重试策略 重试等待时间,单位分钟: 默认: 5
示例值:5
MaxRetryNumber Integer 重试策略 最大尝试次数, 默认: 4
示例值:4
ExecutionTTLMinute Integer 超时处理策略 运行耗时超时(单位:分钟)默认为 -1
示例值:-1
WaitExecutionTotalTTLMinute Integer 超时处理策略 等待总时长耗时超时(单位:分钟)默认为 -1
示例值:-1

CreateTriggerTaskBaseAttribute

创建任务基本属性信息

被如下接口引用:CreateTriggerTask。

名称 类型 必选 描述
TaskName String 任务名称
示例值:sh_api_250827_205043
TaskTypeId String 任务类型ID:
* 26:OfflineSynchronization
* 30:Python
* 32:DLC SQL
* 35:Shell
* 38:Shell Form Mode
* 46:DLC Spark
* 50:DLC PySpark
* 130:Branch Node
* 131:Merged Node
* 132:Notebook
* 133:SSH
* 137:For-each
* 139:DLC Spark Streaming
* 140:Run Workflow
示例值:35
WorkflowId String 工作流ID
示例值:09cfab2c-8d4d-45e5-8af5-80b82f87ccb4
OwnerUin String 任务负责人ID,默认为当前用户
示例值:100028571357
TaskDescription String 任务描述
示例值:this is a shell task!
TaskFolderPath String 任务文件夹路径

注意:
- 路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
- 如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;
示例值:/tf_01

CreateTriggerTaskConfiguration

创建任务配置信息

被如下接口引用:CreateTriggerTask。

名称 类型 必选 描述
ResourceGroup String 资源组ID: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId
示例值:20240222212719833743
CodeContent String 代码内容的Base64编码
示例值:cHJpbnQoJ2hlbGxvIHdvcmxkIScp
TaskExtConfigurationList Array of TaskExtParameter 任务扩展属性配置列表
DataCluster String 集群ID
示例值:2568295b-56ac-4a74-8b37-4c8b17545353
BrokerIp String 指定的运行节点
示例值:any
YarnQueue String 资源池队列名称,需要通过 DescribeProjectClusterQueues 获取
示例值:default
SourceServiceId String 来源数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取
示例值:8444
TargetServiceId String 目标数据源ID, 使用 ; 分隔, 需要通过 DescribeDataSourceWithoutInfo 获取
示例值:61933
TaskSchedulingParameterList Array of TaskSchedulingParameter 调度参数
BundleId String Bundle使用的ID
示例值:1
BundleInfo String Bundle信息
示例值:{"BundleName":"test", BundlePath:"/test"}

CreateTriggerTaskSchedulerConfiguration

创建任务调度配置信息

被如下接口引用:CreateTriggerTask。

名称 类型 必选 描述
UpstreamDependencyConfigList Array of DependencyTriggerTaskBrief 上游依赖的任务数组
RunPriorityType Integer 任务调度优先级 运行优先级 4高 5中 6低 , 默认:6
示例值:6
RetryWaitMinute Integer 重试策略 重试等待时间,单位分钟: 默认: 5
示例值:5
MaxRetryNumber Integer 重试策略 最大尝试次数, 默认: 4
示例值:4
ExecutionTTLMinute Integer 超时处理策略 运行耗时超时(单位:分钟)默认为 -1
示例值:-1
WaitExecutionTotalTTLMinute Integer 超时处理策略 等待总时长耗时超时(单位:分钟)默认为 -1
示例值:-1
AllowRedoType String 重跑&补录配置, 默认为 ALL; , ALL 运行成功或失败后皆可重跑或补录, FAILURE 运行成功后不可重跑或补录,运行失败后可重跑或补录, NONE 运行成功或失败后皆不可重跑或补录;
示例值:ALL
ParamTaskOutList Array of OutTaskParameter 输出参数数组
ParamTaskInList Array of InTaskParameter 输入参数数组
TaskOutputRegistryList Array of TaskDataRegistry 产出登记

CreateTriggerWorkflowResult

创建工作流结果

被如下接口引用:CreateTriggerWorkflow。

名称 类型 描述
WorkflowId String 创建成功后的工作流id
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

CreateWorkflowPermissionsResult

工作流授权结果

被如下接口引用:CreateWorkflowPermissions。

名称 类型 描述
Status Boolean 实体授权结果,true/false

CreateWorkflowResult

创建工作流结果

被如下接口引用:CreateWorkflow。

名称 类型 描述
WorkflowId String 创建成功后的工作流id

DLCClusterInfo

dlc集群信息

被如下接口引用:AddCalcEnginesToProject, CreateProject。

名称 类型 必选 描述
ComputeResources Array of String dlc资源名称(需要添加角色Uin到dlc中,否则可能获取不到资源)
注意:此字段可能返回 null,表示取不到有效值。
示例值:["svmgao_superSQL_Spark作业"]
Region String dlc地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
DefaultDatabase String 指定DLC集群的默认数据库
注意:此字段可能返回 null,表示取不到有效值。
示例值:lgx_test_0825
StandardModeEnvTag String 集群配置标记( 仅对标准模式的项目生效并且标准模式必填),枚举值:
- Prod (生产环境)
- Dev (开发环境)
示例值:Dev
AccessAccount String 访问账号( 仅对标准模式的项目生效并且标准模式必填),用于提交dlc任务的账号
建议使用指定子账号,给子账号设置对应库表的权限;任务负责人模式在负责人离职后容易造成任务失败;主账号模式在多个项目权限不同的情况下不易做权限控制。

枚举值:
- TASK_RUNNER (任务负责人)
- OWNER (主账号模式)
- SUB (子账号模式)
示例值:SUB
SubAccountUin String 子账号id( 仅对标准模式的项目生效),AccessAccount为子账号模式时,需要指定子账号的id信息,其他模式不需要指定
示例值:153574

DataBackfill

补录计划详情

被如下接口引用:GetDataBackfillPlan。

名称 类型 描述
ProjectId String 项目Id
DataBackfillPlanId String 数据补录计划id
DataBackfillPlanName String 数据补录计划名称
TaskIds Array of String 补录任务集合
DataBackfillRangeList Array of DataBackfillRange 补录任务的数据配置列表
CheckParentType String 检查父任务类型,取值范围:- NONE-全部不检查- ALL-检查全部上游父任务- MAKE_SCOPE-只在(当前补录计划)选中任务中检查
注意:此字段可能返回 null,表示取不到有效值。
SkipEventListening Boolean 补录是否忽略事件依赖
注意:此字段可能返回 null,表示取不到有效值。
RedefineParallelNum Integer 自定义实例运行并发度, 返回为null或者不返回,则表示任务原有自依赖
注意:此字段可能返回 null,表示取不到有效值。
RedefineSelfWorkflowDependency String 自定义的工作流自依赖,yes或者no;如果不配置,则使用工作流原有自依赖
注意:此字段可能返回 null,表示取不到有效值。
SchedulerResourceGroupId String 调度资源组id
注意:此字段可能返回 null,表示取不到有效值。
IntegrationResourceGroupId String 集成资源组id
注意:此字段可能返回 null,表示取不到有效值。
RedefineCycleType String 补录自定义的生成周期
注意:此字段可能返回 null,表示取不到有效值。
RedefineParamList Array of KVPair 自定义参数
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 补录任务的执行开始时间
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 补录任务的执行结束时间
注意:此字段可能返回 null,表示取不到有效值。
CreateUserUin String 创建用户id
CompletePercent Integer 补录计划实例完成百分数
SuccessPercent Integer 补录计划实例成功百分数
DataTimeOrder String 补录是实例数据时间顺序,生效必须满足2个条件:1. 必须同周期任务2. 优先按依赖关系执行,无依赖关系影响的情况下按配置执行顺序执行 可选值- NORMAL: 不设置- ORDER: 顺序- REVERSE: 逆序不设置默认为NORMAL
注意:此字段可能返回 null,表示取不到有效值。

DataBackfillRange

补录计划日期范围

被如下接口引用:CreateDataBackfillPlan, GetDataBackfillPlan。

名称 类型 必选 描述
StartDate String 开始日期,格式yyyy-MM-dd 表示从指定日期的00:00:00开始
注意:此字段可能返回 null,表示取不到有效值。
EndDate String 结束日期,格式yyyy-MM-dd,表示从指定日期的 23:59:59结束
注意:此字段可能返回 null,表示取不到有效值。
ExecutionStartTime String 在[StartDate, EndDate]之间每天的开始时间点,格式HH:mm,只针对小时及周期小于小时的任务生效
注意:此字段可能返回 null,表示取不到有效值。
ExecutionEndTime String 在[StartDate, EndDate]之间每天的结束时间点,格式HH:mm,只针对小时及周期小于小时的任务生效
注意:此字段可能返回 null,表示取不到有效值。

DataSource

数据源对象

被如下接口引用:GetDataSource, ListDataSources。

名称 类型 描述
ProjectId String 归属项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:13524679
Id Integer 数据源ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1357
Type String 数据源类型:枚举值
注意:此字段可能返回 null,表示取不到有效值。
示例值:MYSQL
Name String 数据源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:mysql1
DisplayName String 数据源展示名,为了可视化查看
注意:此字段可能返回 null,表示取不到有效值。
示例值:mysql1
Description String 数据源描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:description
ProjectName String 归属项目Name
注意:此字段可能返回 null,表示取不到有效值。
示例值:项目A
CreateUser String 数据源创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:user1
CreateTime String 时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-10-10 12:00:00
ModifyUser String 更新人
注意:此字段可能返回 null,表示取不到有效值。
示例值:user1
ModifyTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-10-10 12:00:00
ProdConProperties String 数据源的配置信息,以JSON KV存储,根据每个数据源类型不同,而KV存储信息不同
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"deployType":"CONNSTR_CVMDB","url":"jdbc:mysql://1.1.1.1:1111/database","username":"aaaa","password":"aaaa","region":"ap-guangzhou","vpcId":"vpc-ds5rpnxh"}
DevConProperties String 同params 内容为开发数据源的数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"deployType":"CONNSTR_CVMDB","url":"jdbc:mysql://1.1.1.1:1111/database","username":"aaaa","password":"aaaa","region":"ap-guangzhou","vpcId":"vpc-ds5rpnxh"}
Category String 数据源类别:

- DB ---自定义源
- CLUSTER --- 系统源
注意:此字段可能返回 null,表示取不到有效值。
示例值:DB

DataSourceFileUpload

数据源文件上传

被如下接口引用:CreateDataSource, UpdateDataSource。

名称 类型 必选 描述
TrustStore String Truststore认证文件,默认文件名truststore.jks
KeyStore String Keystore认证文件,默认文件名keystore.jks
CoreSite String core-site.xml文件
HdfsSite String hdfs-site.xml文件
HiveSite String hive-site.xml文件
HBASESite String hbase-site文件
KeyTab String keytab文件,默认文件名[数据源名].keytab
KRB5Conf String krb5.conf文件
PrivateKey String 私钥,默认文件名private_key.pem
PublicKey String 公钥,默认文件名public_key.pem

DataSourceInfo

查询数据源分页列表

被如下接口引用:ListDataSources。

名称 类型 描述
PageNumber Integer 分页页码
注意:此字段可能返回 null,表示取不到有效值。
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
Items Array of DataSource 数据源列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 总分页页码
注意:此字段可能返回 null,表示取不到有效值。

DataSourceResult

数据源操作结果

被如下接口引用:CreateDataSource。

名称 类型 描述
Status Boolean 操作是否成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DataSourceId Integer 数据源id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1357

DataSourceStatus

数据源操作结果

被如下接口引用:AuthorizeDataSource, DeleteDataSource, RevokeDataSourceAuthorization, UpdateDataSource。

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

DatabaseInfo

数据库信息

被如下接口引用:ListDatabase。

名称 类型 必选 描述
Guid String 数据库GUID
注意:此字段可能返回 null,表示取不到有效值。
Name String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
CatalogName String 数据库目录
注意:此字段可能返回 null,表示取不到有效值。
Description String 数据库描述
注意:此字段可能返回 null,表示取不到有效值。
Location String 数据库位置
注意:此字段可能返回 null,表示取不到有效值。
StorageSize Integer 数据库存储大小
注意:此字段可能返回 null,表示取不到有效值。

DatasourceRelationTaskInfo

数据源关联任务信息

被如下接口引用:GetDataSourceRelatedTasks。

名称 类型 描述
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2467542
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:项目
TaskInfo Array of RelateTask 数据源关联任务信息,本期仅支持数据开发任务接口返回数据
注意:此字段可能返回 null,表示取不到有效值。

DeleteAlarmRuleResult

删除告警规则响应结果

被如下接口引用:DeleteOpsAlarmRule。

名称 类型 描述
Status Boolean 是否删除成功

DeleteFolderResult

删除资源文件夹结果

被如下接口引用:DeleteResourceFolder, DeleteWorkflowFolder。

名称 类型 描述
Status Boolean 删除状态,true表示成功,false表示失败
示例值:true

DeleteQualityRuleGroupResultVO

批量规则操作的返回信息

被如下接口引用:DeleteQualityRuleGroup。

名称 类型 描述
SumCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
SuccessCount Integer 成功条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
FailedCount Integer 失败条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Results Array of CommonQualityOperateResult 操作详情
注意:此字段可能返回 null,表示取不到有效值。

DeleteResourceFileResult

删除资源文件结果

被如下接口引用:DeleteResourceFile。

名称 类型 描述
Status Boolean true

DeleteTaskFolderResult

删除资源文件夹结果

被如下接口引用:DeleteTaskFolder。

名称 类型 描述
Status Boolean 删除状态,true表示成功,false表示失败

DeleteTaskResult

删除数据开发任务结果

被如下接口引用:DeleteTask, DeleteTriggerTask。

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

DeleteTriggerWorkflowResult

删除工作流结果

被如下接口引用:DeleteTriggerWorkflow。

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

DeleteWorkflowPermission

要删除的数据开发授权信息

被如下接口引用:DeleteWorkflowPermissions。

名称 类型 必选 描述
PermissionTargetType String 要删除的授权目标类型(用户:user,角色:role,组:group)
PermissionTargetId String 要删除的授权目标id(userId/roleId)
PermissionTypeList Array of String 要删除的授权权限类型数组(CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE,当前仅支持CAN_MANAGE)

DeleteWorkflowPermissionsResult

数据开发权限删除结果

被如下接口引用:DeleteWorkflowPermissions。

名称 类型 描述
Status Boolean 整体删除结果 true/false
示例值:true

DeleteWorkflowResult

删除工作流结果

被如下接口引用:DeleteWorkflow。

名称 类型 描述
Status Boolean 删除工作流是否成功

DependencyConfigPage

查询任务上游依赖详情分页

被如下接口引用:ListDownstreamTasks, ListUpstreamTasks。

名称 类型 描述
TotalCount Integer 满足查询条件的数据总条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 满足查询条件的数据总页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageNumber Integer 当前请求的数据页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
Items Array of TaskDependDto 分页数据
注意:此字段可能返回 null,表示取不到有效值。

DependencyStrategyTask

依赖配置策略

被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially。

名称 类型 必选 描述
PollingNullStrategy String 等待上游任务实例策略:EXECUTING(执行);WAITING(等待)

注意:此字段可能返回 null,表示取不到有效值。
示例值:EXECUTING
TaskDependencyExecutingStrategies Array of String 仅当PollingNullStrategy为EXECUTING时才需要填本字段,List类型:NOT_EXIST(默认,在分钟依赖分钟/小时依赖小时的情况下,父实例不在下游实例调度时间范围内);PARENT_EXPIRED(父实例失败);PARENT_TIMEOUT(父实例超时)。以上场景满足任一条件即可通过该父任务实例依赖判断,除以上场景外均需等待父实例。

注意:此字段可能返回 null,表示取不到有效值。
示例值:["PARENT_TIMEOUT"]
TaskDependencyExecutingTimeoutValue Integer 仅当TaskDependencyExecutingStrategies中包含PARENT_TIMEOUT时才需要填本字段,下游任务依赖父实例执行超时时间,单位:分钟。

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

DependencyTaskBrief

依赖任务信息

取值说明表:

当前任务周期类型 上游任务周期类型 配置方式 MainCyclicConfig取值 时间维度/实例范围 SubordinateCyclicConfig取值 offset取值
HOUR_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
MINUTE_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
DAY_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
DAY_CYCLE WEEK_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
HOUR_CYCLE HOUR_CYCLE 推荐策略 HOUR 按小时/最近实例 CURRENT_HOUR
HOUR_CYCLE HOUR_CYCLE 推荐策略 HOUR 按小时/前一周期 PREVIOUS_HOUR_CYCLE
HOUR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/上周 PREVIOUS_WEEK
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/上周五 PREVIOUS_FRIDAY
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/上周日 PREVIOUS_WEEKEND
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
WEEK_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 、 CURRENT_DAY
WEEK_CYCLE DAY_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
WEEK_CYCLE ONEOFF_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
HOUR_CYCLE MINUTE_CYCLE 推荐策略 HOUR 按小时/前一个小时(-60,0] PREVIOUS_HOUR_LATER_OFFSET_MINUTE
HOUR_CYCLE MINUTE_CYCLE 推荐策略 HOUR 按小时/前一个小时 PREVIOUS_HOUR
HOUR_CYCLE MINUTE_CYCLE 推荐策略 HOUR 按小时/当前小时 CURRENT_HOUR
YEAR_CYCLE WEEK_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
WEEK_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
MINUTE_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
WEEK_CYCLE HOUR_CYCLE 推荐策略 WEEK 按周/上周 PREVIOUS_WEEK
WEEK_CYCLE HOUR_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
MINUTE_CYCLE HOUR_CYCLE 推荐策略 HOUR 按小时/当前小时 CURRENT_HOUR
HOUR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE HOUR_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE HOUR_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE ONEOFF_CYCLE 推荐策略 MONTH 按月/当月 CURRENT_MONTH
DAY_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
DAY_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
MONTH_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
ONEOFF_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
MINUTE_CYCLE MINUTE_CYCLE 推荐策略 MINUTE 按分钟/当前分钟 CURRENT_MINUTE
MINUTE_CYCLE MINUTE_CYCLE 推荐策略 MINUTE 按分钟/前一周期 PREVIOUS_MINUTE_CYCLE
YEAR_CYCLE MINUTE_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
ONEOFF_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
DAY_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/前一天(-24 * 60,0] PREVIOUS_DAY_LATER_OFFSET_MINUTE
DAY_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
DAY_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
MINUTE_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
WEEK_CYCLE WEEK_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE YEAR_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
YEAR_CYCLE HOUR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
MINUTE_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
ONEOFF_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
HOUR_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE MINUTE_CYCLE 推荐策略 WEEK 按周/上周 PREVIOUS_WEEK
WEEK_CYCLE MINUTE_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
DAY_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/前一天(-24,0] PREVIOUS_DAY_LATER_OFFSET_HOUR
DAY_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/前一天[-24,0) PREVIOUS_DAY
DAY_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
YEAR_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本年所有月 ALL_MONTH_OF_YEAR
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/上月末 PREVIOUS_END_OF_MONTH
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/上月初 PREVIOUS_BEGIN_OF_MONTH
ONEOFF_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
DAY_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
ONEOFF_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
DAY_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
MINUTE_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
WEEK_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE ONEOFF_CYCLE 推荐策略 YEAR 按年/当年 CURRENT_YEAR
MONTH_CYCLE DAY_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE DAY_CYCLE 推荐策略 MONTH 按月/上月末 PREVIOUS_END_OF_MONTH
MONTH_CYCLE DAY_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
MONTH_CYCLE DAY_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
YEAR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/本年所有天 ALL_DAY_OF_YEAR
YEAR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
YEAR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
HOUR_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
MONTH_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/当月 CURRENT_MONTH
MONTH_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
MONTH_CYCLE MINUTE_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE MINUTE_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE WEEK_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE WEEK_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE WEEK_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
DAY_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
DAY_CYCLE YEAR_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
ONEOFF_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
ONEOFF_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
CRONTAB_CYCLE CRONTAB_CYCLE 推荐策略 CRONTAB CURRENT
HOUR_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
HOUR_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
WEEK_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
HOUR_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
WEEK_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
MONTH_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
YEAR_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
MINUTE_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
WEEK_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
DAY_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
HOUR_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
HOUR_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
WEEK_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
HOUR_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
WEEK_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
MONTH_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
YEAR_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
MINUTE_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
WEEK_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
DAY_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0

被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially。

名称 类型 必选 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:250814205035
MainCyclicConfig String 主依赖配置,取值为:

* CRONTAB
* DAY
* HOUR
* LIST_DAY
* LIST_HOUR
* LIST_MINUTE
* MINUTE
* MONTH
* RANGE_DAY
* RANGE_HOUR
* RANGE_MINUTE
* WEEK
* YEAR
注意:此字段可能返回 null,表示取不到有效值。
示例值:DAY
SubordinateCyclicConfig String 次依赖配置,取值为:
* ALL_DAY_OF_YEAR
* ALL_MONTH_OF_YEAR
* CURRENT
* CURRENT_DAY
* CURRENT_HOUR
* CURRENT_MINUTE
* CURRENT_MONTH
* CURRENT_WEEK
* CURRENT_YEAR
* PREVIOUS_BEGIN_OF_MONTH
* PREVIOUS_DAY
* PREVIOUS_DAY_LATER_OFFSET_HOUR
* PREVIOUS_DAY_LATER_OFFSET_MINUTE
* PREVIOUS_END_OF_MONTH
* PREVIOUS_FRIDAY
* PREVIOUS_HOUR
* PREVIOUS_HOUR_CYCLE
* PREVIOUS_HOUR_LATER_OFFSET_MINUTE
* PREVIOUS_MINUTE_CYCLE
* PREVIOUS_MONTH
* PREVIOUS_WEEK
* PREVIOUS_WEEKEND
* RECENT_DATE
注意:此字段可能返回 null,表示取不到有效值。
示例值:CURRENT_DAY
Offset String 区间、列表模式下的偏移量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1
DependencyStrategy DependencyStrategyTask 依赖执行策略
注意:此字段可能返回 null,表示取不到有效值。

DependencyTriggerTaskBrief

依赖任务信息

被如下接口引用:CreateTriggerTask, GetTriggerTask, UpdateTriggerTask, UpdateTriggerTaskPartially。

名称 类型 必选 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:146

EventListener

监听事件器

被如下接口引用:CreateTask, GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially。

名称 类型 必选 描述
EventName String 事件名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_auto111
EventSubType String 事件周期:SECOND, MIN, HOUR, DAY
注意:此字段可能返回 null,表示取不到有效值。
示例值:DAY
EventBroadcastType String 事件广播类型:SINGLE, BROADCAST
注意:此字段可能返回 null,表示取不到有效值。
示例值:BROADCAST
PropertiesList Array of ParamInfo 扩展信息
注意:此字段可能返回 null,表示取不到有效值。

ExecutionActionBrief

执行操作结果

被如下接口引用:KillTriggerWorkflowRuns。

名称 类型 描述
ItemId String 操作实体 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:dasdanknkfnsfnsdkfn
ItemName String 操作实体名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf-name
ExecutionActionId String 操作 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:dadacbnjasknckdfs
ErrorMessage String 失败信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:error message
OpStatus Boolean 操作状态,true:成功,false:失败
示例值:false

ExecutorResourceGroupData

ExecutorResourceGroup分页对象

被如下接口引用:ListResourceGroups。

名称 类型 描述
Items Array of ExecutorResourceGroupInfo 结果list
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
PageNumber Integer 页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalPageNumber Integer 总分页页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

ExecutorResourceGroupInfo

资源组详情

被如下接口引用:ListResourceGroups。

名称 类型 描述
Id String 资源组唯一标识
Name String 资源组名称
注意:此字段可能返回 null,表示取不到有效值。
Description String 资源组描述
注意:此字段可能返回 null,表示取不到有效值。
ResourceGroupType String 执行资源组类型,不能为空

- Schedule --- 调度资源组
- Integration --- 集成资源组
- DataService -- 数据服务资源组
注意:此字段可能返回 null,表示取不到有效值。
AssociateProjects Array of BindProject 项目集合
注意:此字段可能返回 null,表示取不到有效值。
Region String 区域
注意:此字段可能返回 null,表示取不到有效值。
示例值:beijing
VpcId String vpcId
注意:此字段可能返回 null,表示取不到有效值。
SubNet String 子网id
注意:此字段可能返回 null,表示取不到有效值。
AutoRenewEnabled Boolean 是否自动续费
注意:此字段可能返回 null,表示取不到有效值。

ExploreAuthorizationObject

数据探索文件授权主体

被如下接口引用:CreateCodePermissions。

名称 类型 必选 描述
Resource ExploreFileResource 授权资源信息,包含resourceId和resourceType
注意:此字段可能返回 null,表示取不到有效值。
AuthorizeSubjects Array of ExploreAuthorizeSubject 授权详情
注意:此字段可能返回 null,表示取不到有效值。

ExploreAuthorizationRecycleObject

数据探索文件回收策略

被如下接口引用:DeleteCodePermissions。

名称 类型 必选 描述
Resource ExploreFileResource 文件资源信息
注意:此字段可能返回 null,表示取不到有效值。
RecycleSubjects Array of ExploreAuthorizeSubject 授权详情
注意:此字段可能返回 null,表示取不到有效值。

ExploreAuthorizeSubject

数据探索文件授权主体

被如下接口引用:CreateCodePermissions, DeleteCodePermissions。

名称 类型 必选 描述
SubjectType String 主体类型(用户:user,角色:role,组:group)
注意:此字段可能返回 null,表示取不到有效值。
SubjectValues Array of String 主体值列表
注意:此字段可能返回 null,表示取不到有效值。
Privileges Array of String 权限列表
注意:此字段可能返回 null,表示取不到有效值。

ExploreFilePermissionsPage

数据探索文件权限列表分页

被如下接口引用:ListCodePermissions。

名称 类型 描述
PageNumber Integer 分页页码
注意:此字段可能返回 null,表示取不到有效值。
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
Rows Array of ExploreFilePrivilegeItem 权限列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总个数
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 总分页页码
注意:此字段可能返回 null,表示取不到有效值。

ExploreFilePrivilegeItem

探索文件权限详情

被如下接口引用:ListCodePermissions。

名称 类型 必选 描述
Privileges Array of String 权限点
注意:此字段可能返回 null,表示取不到有效值。
RoleType String 用户:user 角色: role 组:group
注意:此字段可能返回 null,表示取不到有效值。
RoleId String 用户或角色ID
注意:此字段可能返回 null,表示取不到有效值。
Resource ExploreFileResource 授权资源
注意:此字段可能返回 null,表示取不到有效值。
DeleteAble Boolean 是否可以被删除
注意:此字段可能返回 null,表示取不到有效值。

ExploreFileResource

数据探索文件资源

被如下接口引用:CreateCodePermissions, DeleteCodePermissions, ListCodePermissions。

名称 类型 必选 描述
ResourceType String 资源类型,只能是这两种类型: folder, script
注意:此字段可能返回 null,表示取不到有效值。
示例值:script
ResourceId String 资源ID:目录id或脚本id
注意:此字段可能返回 null,表示取不到有效值。
示例值:lsl
ResourceIdForPath String id全路径,用于递归鉴权
注意:此字段可能返回 null,表示取不到有效值。
示例值:dbd
ResourceCFSPath String cfs路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:kksk

Filter

通用过滤器

被如下接口引用:GetTriggerWorkflowRun, ListOpsTriggerWorkflows, ListQualityRuleGroupExecResultsByPage, ListQualityRuleGroups, ListQualityRuleGroupsTable, ListQualityRuleTemplates, ListQualityRules, ListTriggerWorkflowRuns。

名称 类型 必选 描述
Name String 过滤字段名称
Values Array of String 过滤值列表

InTaskParameter

参数传递-引用参数

被如下接口引用:CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially。

名称 类型 必选 描述
ParamKey String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:intask_v
ParamDesc String 参数描述:格式为 项目标识.任务名称.参数名;例:project_wedata_1.sh_250820_104107.pp_out
注意:此字段可能返回 null,表示取不到有效值。
示例值:DATA_DEV_SIM_PROJ_01.sh_241204_111248.taskout_v1
FromTaskId String 父任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20241204111252781
FromParamKey String 父任务参数key
注意:此字段可能返回 null,表示取不到有效值。
示例值:taskout_v1

InstanceExecution

调度实例详情

被如下接口引用:ListTaskInstanceExecutions。

名称 类型 描述
InstanceKey String 实例唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240627201611119_2025-03-20 00:00:00
LifeRoundNum Integer 实例生命周期编号,标识实例的某一次执行

例如:周期实例第一次运行的编号为0,用户后期又重跑了该实例,第二次执行的编号为1
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InstanceState String 实例状态
- WAIT_EVENT: 等待事件
- WAIT_UPSTREAM: 等待上游
- WAIT_RUN: 等待运行
- RUNNING: 运行中
- SKIP_RUNNING: 跳过运行
- FAILED_RETRY: 失败重试
- EXPIRED: 失败
- COMPLETED: 成功
注意:此字段可能返回 null,表示取不到有效值。
RunType String 实例运行触发类型

- RERUN 表示重跑
- ADDITION 表示补录
- PERIODIC 表示周期
- APERIODIC 表示非周期
- RERUN_SKIP_RUN 表示重跑 - 空跑
- ADDITION_SKIP_RUN 表示补录 - 空跑
- PERIODIC_SKIP_RUN 表示周期 - 空跑
- APERIODIC_SKIP_RUN 表示非周期 - 空跑
- MANUAL_TRIGGER 表示手动触发
- RERUN_MANUAL_TRIGGER 表示手动触发 - 重跑
注意:此字段可能返回 null,表示取不到有效值。
示例值:PERIODIC
Tries Integer 失败重试次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExecutionPhaseList Array of InstanceExecutionPhase 实例执行生命周期列表
注意:此字段可能返回 null,表示取不到有效值。
CostTime Integer 耗费时间, 单位ms
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

InstanceExecutionPhase

实例执行的每个阶段详情

被如下接口引用:ListTaskInstanceExecutions。

名称 类型 必选 描述
StartTime String 该状态开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-28 00:00:00
DetailState String 实例生命周期阶段状态

- WAIT_UPSTREAM 表示 等待事件/上游状态
- WAIT_RUN 表示 等待运行状态
- RUNNING 表示 运行中状态
- COMPLETE 表示 终态-完成
- FAILED 表示 终态-失败重试
- EXPIRED 表示 终态-失败
- SKIP_RUNNING 表示 终态-被上游分支节点跳过的分支
- HISTORY 表示 兼容2024-03-30之前的历史实例,之后实例无需关注次枚举类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:RUNNING
EndTime String 该状态结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-28 00:00:05

InstanceLog

实例日志内容

被如下接口引用:GetTaskInstanceLog。

名称 类型 描述
InstanceKey String 实例唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240627201611119_2025-03-20 00:00:00
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1531612696090365952
CodeContent String 运行代码内容
注意:此字段可能返回 null,表示取不到有效值。
LogInfo String 日志内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:[INFO] echo 1
NextCursor String 分页查询日志时使用,无具体业务含义

第一次查询时值为null
第二次及以后查询时使用上一次查询返回信息中的NextCursor字段值即可
注意:此字段可能返回 null,表示取不到有效值。
示例值:115715

IntegrationResource

集成资源组

被如下接口引用:CreateResourceGroup。

名称 类型 必选 描述
RealTimeDataSync ResourceGroupSpecification 实时集成资源组

- i32c(实时数据同步-16C64G)
OfflineDataSync ResourceGroupSpecification 离线集成资源组

- integrated(离线数据同步-8C16G)
- i16(离线数据同步-8C32G)

JobDto

数据探索任务JOB

被如下接口引用:ListSQLScriptRuns, RunSQLScript。

名称 类型 必选 描述
JobId String 数据探索任务ID
注意:此字段可能返回 null,表示取不到有效值。
JobName String 数据探索任务名称
注意:此字段可能返回 null,表示取不到有效值。
JobType String 任务类型
注意:此字段可能返回 null,表示取不到有效值。
ScriptId String 脚本ID
注意:此字段可能返回 null,表示取不到有效值。
JobExecutionList Array of JobExecutionDto 子任务列表
注意:此字段可能返回 null,表示取不到有效值。
ScriptContent String 脚本内容
注意:此字段可能返回 null,表示取不到有效值。
Status String 任务状态
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 任务创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
OwnerUin String 云主账号UIN
注意:此字段可能返回 null,表示取不到有效值。
UserUin String 账号UIN
注意:此字段可能返回 null,表示取不到有效值。
TimeCost Integer 耗时
注意:此字段可能返回 null,表示取不到有效值。
ScriptContentTruncate Boolean 是否脚本内容被截断
注意:此字段可能返回 null,表示取不到有效值。

JobExecutionDto

业务提交JOB的子任务

被如下接口引用:ListSQLScriptRuns, RunSQLScript。

名称 类型 必选 描述
JobId String 数据探索任务ID
注意:此字段可能返回 null,表示取不到有效值。
JobExecutionId String 子查询任务ID
注意:此字段可能返回 null,表示取不到有效值。
JobExecutionName String 子查询名称
注意:此字段可能返回 null,表示取不到有效值。
ScriptContent String 子查询sql内容
注意:此字段可能返回 null,表示取不到有效值。
Status String 子查询状态
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
ExecuteStageInfo String 执行阶段
注意:此字段可能返回 null,表示取不到有效值。
LogFilePath String 日志路径
注意:此字段可能返回 null,表示取不到有效值。
ResultFilePath String 下载结果路径
注意:此字段可能返回 null,表示取不到有效值。
ResultPreviewFilePath String 预览结果路径
注意:此字段可能返回 null,表示取不到有效值。
ResultTotalCount Integer 任务执行的结果总行数
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
TimeCost Integer 耗时
注意:此字段可能返回 null,表示取不到有效值。
ContextScriptContent Array of String 上下文SQL内容
注意:此字段可能返回 null,表示取不到有效值。
ResultPreviewCount Integer 任务执行的结果预览行数
注意:此字段可能返回 null,表示取不到有效值。
ResultEffectCount Integer 任务执行的结果影响行数
注意:此字段可能返回 null,表示取不到有效值。
CollectingTotalResult Boolean 是否正在收集全量结果:默认false,true表示正在收集全量结果,用于前端判断是否需要继续轮询
注意:此字段可能返回 null,表示取不到有效值。
ScriptContentTruncate Boolean 是否需要截断脚本内容
注意:此字段可能返回 null,表示取不到有效值。

KVMap

map

被如下接口引用:RerunTaskInstancesAsync。

名称 类型 必选 描述
K String k
注意:此字段可能返回 null,表示取不到有效值。
V String v
注意:此字段可能返回 null,表示取不到有效值。

KVPair

键值对

被如下接口引用:CreateDataBackfillPlan, GetDataBackfillPlan。

名称 类型 必选 描述
K String 键名
注意:此字段可能返回 null,表示取不到有效值。
示例值:Name
V String 值,请勿传SQL(请求会被视为攻击接口),如果有需要,请将SQL进行Base64转码并解码。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Tom

LineageNodeInfo

LineageNodeInfo 血缘关系实体

被如下接口引用:ListColumnLineage, ListLineage。

名称 类型 描述
Resource LineageResource 当前资源
注意:此字段可能返回 null,表示取不到有效值。
Relation LineageRelation 关系
注意:此字段可能返回 null,表示取不到有效值。

LineagePair

血缘Pair对象

被如下接口引用:DeleteLineage, ListProcessLineage, RegisterLineage。

名称 类型 必选 描述
Source LineageResouce 来源
Target LineageResouce 目标
Processes Array of LineageProcess 血缘加工过程

LineageProcess

LineageProcess 血缘产出过程

被如下接口引用:DeleteLineage, ListColumnLineage, ListLineage, ListProcessLineage, RegisterLineage。

名称 类型 必选 描述
ProcessId String 原始唯一ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:110111121
ProcessType String 任务类型
//调度任务
SCHEDULE_TASK,
//集成任务
INTEGRATION_TASK,
//第三方上报
THIRD_REPORT,
//数据建模
TABLE_MODEL,
//模型创建指标
MODEL_METRIC,
//原子指标创建衍生指标
METRIC_METRIC,
//数据服务
DATA_SERVICE
注意:此字段可能返回 null,表示取不到有效值。
示例值:SCHEDULE_TASK
Platform String WEDATA, THIRD;
注意:此字段可能返回 null,表示取不到有效值。
示例值:WEDATA
ProcessSubType String 任务子类型
SQL_TASK,
//集成实时任务血缘
INTEGRATED_STREAM,
//集成离线任务血缘
INTEGRATED_OFFLINE;
注意:此字段可能返回 null,表示取不到有效值。
示例值:SQL_TASK
ProcessProperties Array of LineageProperty 额外扩展参数
注意:此字段可能返回 null,表示取不到有效值。
LineageNodeId String 血缘任务唯一节点ID

LineageProperty

LineageProperty额外扩展参数

被如下接口引用:DeleteLineage, ListColumnLineage, ListLineage, ListProcessLineage, RegisterLineage。

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

LineageRelation

LineageRelation 血缘关系

被如下接口引用:ListColumnLineage, ListLineage。

名称 类型 描述
RelationId String 关联ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:r90Fgu4vYm6UHyBrPDZ
SourceUniqueId String 源端唯一血缘ID
注意:此字段可能返回 null,表示取不到有效值。
TargetUniqueId String 目标端唯一血缘ID
注意:此字段可能返回 null,表示取不到有效值。
Processes Array of LineageProcess 血缘加工过程
注意:此字段可能返回 null,表示取不到有效值。

LineageResouce

血缘资源实体

被如下接口引用:DeleteLineage, ListProcessLineage, RegisterLineage。

名称 类型 必选 描述
ResourceUniqueId String 实体原始唯一ID\n
备注:当血缘为表的列时候 唯一ID传表ResourceUniqueId::字段名称
注意:此字段可能返回 null,表示取不到有效值。
ResourceType String 实体类型
TABLE|METRIC|MODEL|SERVICE|COLUMN
注意:此字段可能返回 null,表示取不到有效值。
示例值:TABLE
Platform String 来源:WEDATA|THIRD
默认wedata
注意:此字段可能返回 null,表示取不到有效值。
示例值:WEDATA
ResourceName String 业务名称:库名.表名|指标名称|模型名称|字段名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx.xxx.xxx
Description String 描述:表类型|指标描述|模型描述|字段描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:HIVE
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-14 00:00:00
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-14 00:00:00
ResourceProperties Array of LineageProperty resource 额外扩展参数
注意:此字段可能返回 null,表示取不到有效值。
LineageNodeId String 血缘节点唯一标识符号

LineageResource

血缘资源实体

被如下接口引用:ListColumnLineage, ListLineage。

名称 类型 必选 描述
ResourceUniqueId String 实体原始唯一ID
注意:此字段可能返回 null,表示取不到有效值。
ResourceName String 业务名称:库名.表名|指标名称|模型名称|字段名称
注意:此字段可能返回 null,表示取不到有效值。
ResourceType String 实体类型
TABLE|METRIC|MODEL|SERVICE|COLUMN
注意:此字段可能返回 null,表示取不到有效值。
LineageNodeId String 血缘节点唯一标识符号
注意:此字段可能返回 null,表示取不到有效值。
Description String 描述:表类型|指标描述|模型描述|字段描述
注意:此字段可能返回 null,表示取不到有效值。
Platform String 来源:WEDATA|THIRD
默认wedata
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
ResourceProperties Array of LineageProperty resource 额外扩展参数
注意:此字段可能返回 null,表示取不到有效值。

ListAlarmMessages

告警信息列表

被如下接口引用:ListAlarmMessages。

名称 类型 描述
PageNumber Integer 页码
示例值:1
PageSize Integer 分页大小
示例值:20
TotalCount Integer 总条数
示例值:100
TotalPageNumber Integer 总页数
Items Array of AlarmMessage 告警信息列表

ListAlarmRulesResult

查询告警规则列表

被如下接口引用:ListOpsAlarmRules。

名称 类型 描述
PageNumber Integer 分页的页数,当前页数
示例值:1
PageSize Integer 每页显示的条数
TotalPageNumber Integer 分页总页数
TotalCount Integer 所有的告警规则个数
Items Array of AlarmRuleData 告警规则信息列表

ListCatalogPage

ListCatalogPage

被如下接口引用:ListCatalog。

名称 类型 描述
Items Array of CatalogInfo 目录记录列表
PageCount Integer 分页总页数
PageSize Integer 分页大小
PageNumber Integer 分页页码
TotalCount Integer 记录总数

ListDatabasePage

ListDatabasePage

被如下接口引用:ListDatabase。

名称 类型 描述
Items Array of DatabaseInfo 数据库记录列表
PageCount Integer 分页总页数
PageSize Integer 分页大小
PageNumber Integer 分页页码
TotalCount Integer 记录总数

ListLineagePage

ListLineagePage

被如下接口引用:ListColumnLineage, ListLineage。

名称 类型 描述
Items Array of LineageNodeInfo 血缘记录列表
PageCount Integer 分页总页数
示例值:1
PageSize Integer 分页大小
示例值:10
PageNumber Integer 分页页码
示例值:1
TotalCount Integer 记录总数
示例值:1

ListOpsTasksPage

任务列表分页

被如下接口引用:ListOpsTasks。

名称 类型 描述
TotalCount Integer 结果总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Items Array of TaskOpsInfo 记录列表
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

ListProcessLineagePage

ListLineagePage

被如下接口引用:ListProcessLineage。

名称 类型 描述
Items Array of LineagePair 血缘pair列表
PageCount Integer 分页总页数
示例值:1
PageSize Integer 分页大小
示例值:10
PageNumber Integer 分页页码
示例值:1
TotalCount Integer 记录总数
示例值:1

ListQualityRuleGroupExecResult

规则组执行结果

被如下接口引用:ListQualityRuleGroupExecResultsByPage。

名称 类型 必选 描述
RuleGroupExecId Integer 规则组执行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleGroupId Integer 规则组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TriggerType Integer 执行触发类型(1:手动触发, 2:调度事中触发,3:周期调度触发)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExecTime String 执行时间 yyyy-MM-dd HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
Status Integer 执行状态(1.已提交 2.检测中 3.正常 4.异常)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AlarmRuleCount Integer 异常规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalRuleCount Integer 总规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableOwnerName String 源表负责人
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableName String 源表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableId String 表id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatabaseId String 数据库id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatasourceId String 数据源ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
Permission Boolean 有无权限
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ExecDetail String 执行详情,调度计划或者关联生产任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
EngineType String 实际执行引擎
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RuleExecResultVOList Array of QualityRuleExecResult 规则执行结果
注意:此字段可能返回 null,表示取不到有效值。
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RuleGroupTableId Integer 本地规则表id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterDeployType String 集群部署类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
InstanceId String 实例id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DsEnvType Integer 数据库所属环境,0.未定义,1.生产 2.开发
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
InstanceStatus String 实例状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
StartTime String 实例运行的开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FinishTime String 实例运行的结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RuleGroupName String 监控名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RuleGroupExist Integer 判断是否屏蔽监控 0.屏蔽 1.不屏蔽
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BizCatalogName String 类目名
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
BizCatalogId String 类目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FailMsg String 失败原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

ListQualityRuleGroupExecResultPage

规则组执行结果分页

被如下接口引用:ListQualityRuleGroupExecResultsByPage。

名称 类型 必选 描述
TotalCount Integer 记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of ListQualityRuleGroupExecResult 规则组执行结果
注意:此字段可能返回 null,表示取不到有效值。

ListSchemaPage

ListSchemaPage

被如下接口引用:ListSchema。

名称 类型 描述
Items Array of SchemaInfo Schema记录列表
PageCount Integer 分页总页数
PageSize Integer 分页大小
PageNumber Integer 分页页码
TotalCount Integer 记录总数

ListTablePage

ListTablePage

被如下接口引用:ListTable。

名称 类型 描述
Items Array of TableInfo Schema记录列表
PageCount Integer 分页总页数
PageSize Integer 分页大小
PageNumber Integer 分页页码
TotalCount Integer 记录总数

ListTaskInfo

查询任务信息分页

被如下接口引用:ListTasks。

名称 类型 描述
Items Array of TaskBaseAttribute 任务数组
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 当前请求的数据页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 满足查询条件的数据总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
TotalPageNumber Integer 满足查询条件的数据总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

ListTaskVersions

查询任务版本分页列表

被如下接口引用:ListTaskVersions。

名称 类型 描述
Items Array of TaskVersion 记录列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 满足查询条件的数据总条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 满足查询条件的数据总页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageCount Integer 当前页记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
PageNumber Integer 当前请求的数据页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ListTriggerTaskInfo

查询任务信息分页

被如下接口引用:ListTriggerTasks。

名称 类型 描述
Items Array of TriggerTaskBaseAttribute 任务数组
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 当前请求的数据页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 满足查询条件的数据总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 满足查询条件的数据总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ListTriggerTaskVersions

查询任务版本分页列表

被如下接口引用:ListTriggerTaskVersions。

名称 类型 描述
Items Array of TriggerTaskVersion 记录列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 满足查询条件的数据总条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
TotalPageNumber Integer 满足查询条件的数据总页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
PageCount Integer 当前页记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
PageSize Integer 当前请求的数据页条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
PageNumber Integer 当前请求的数据页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ListTriggerWorkflowInfo

查询工作流分页列表

被如下接口引用:ListTriggerWorkflows。

名称 类型 描述
Items Array of TriggerWorkflowInfo 列表item
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 满足查询条件的数据总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageNumber Integer 当前请求的数据页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
TotalCount Integer 满足查询条件的数据总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ListWorkflowInfo

查询工作流分页列表

被如下接口引用:ListWorkflows。

名称 类型 描述
Items Array of WorkflowInfo 列表item
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 满足查询条件的数据总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
PageNumber Integer 当前请求的数据页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 满足查询条件的数据总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:200

MetricData

监控指标

被如下接口引用:GetResourceGroupMetrics。

名称 类型 描述
MetricName String 指标名称

- ConcurrencyUsage --- 并发使用率
- CpuCoreUsage --- cpu使用率
- CpuLoad --- cpu负载
- DevelopQueueTask --- 正在队列中的开发任务数量
- DevelopRunningTask --- 正在运行的开发任务数量
- DevelopSchedulingTask --- 正在调度的开发任务数量
- DiskUsage --- 磁盘使用情况
- DiskUsed --- 磁盘已用量
- MaximumConcurrency --- 最大并发
- MemoryLoad --- 内存负载
- MemoryUsage --- 内存使用量
注意:此字段可能返回 null,表示取不到有效值。
示例值:cpu
SnapshotValue Integer 当前值
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TrendList Array of TrendData 指标趋势
注意:此字段可能返回 null,表示取不到有效值。

ModifyAlarmRuleResult

更新告警规则响应

被如下接口引用:UpdateOpsAlarmRule。

名称 类型 描述
Status Boolean 是否更新成功

ModifyQualityRuleGroupResultVO

监控任务

被如下接口引用:ModifyQualityRuleGroup。

名称 类型 必选 描述
Result Boolean 结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

MonitorWhiteTask

告警规则监控白名单配置

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
MonitorObjectId String 配置白名单的对应的工作流/项目的id
示例值:5c2836a****25
TaskIds Array of String 白名单任务列表
示例值:["2025****28299"]

NotebookSessionInfo

notebook kernel session信息

被如下接口引用:CreateCodeFile, UpdateCodeFile。

名称 类型 必选 描述
NotebookSessionId String 会话ID
NotebookSessionName String 会话名称

NotificationFatigue

告警疲劳告警配置

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
NotifyCount Integer 告警次数
示例值:1
NotifyInterval Integer 告警间隔,分钟
示例值:5
QuietIntervals Array of AlarmQuietInterval 免打扰时间,例如示例值
[{DaysOfWeek: [1, 2], StartTime: "00:00:00", EndTime: "09:00:00"}]
每周一、周二的00:00到09:00免打扰
注意:此字段可能返回 null,表示取不到有效值。

OperateResult

OperateResult

被如下接口引用:DeleteLineage, RegisterLineage。

名称 类型 必选 描述
Status Integer 操作结果1 成功 其他失败

OpsAsyncJobDetail

异步操作详情

被如下接口引用:GetOpsAsyncJob。

名称 类型 必选 描述
ProjectId String 项目id
示例值:1531612696090365952
AsyncId String 操作id
AsyncType String 异步操作类型
Status String 异步操作状态:初始状态: INIT; 运行中: RUNNING; 成功: SUCCESS; 失败: FAIL; 部分成功: PART_SUCCESS
示例值:SUCCESS
ErrorDesc String 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:invalid request
TotalSubProcessCount Integer 子操作总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
FinishedSubProcessCount Integer 已完成的子操作个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
SuccessSubProcessCount Integer 已成功的子操作个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
CreateUserUin String 操作人id
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 操作创建时间
示例值:2025-08-08 19:42:40
UpdateTime String 更新时间
示例值:2025-08-08 19:42:40

OpsAsyncResponse

异步操作返回结构体

被如下接口引用:DeleteDataBackfillPlanAsync, KillTaskInstancesAsync, PauseOpsTasksAsync, RerunTaskInstancesAsync, RerunTriggerWorkflowRunAsync, SetSuccessTaskInstancesAsync, StopOpsTasksAsync。

名称 类型 描述
AsyncId String 异步执行记录Id

OpsTaskDepend

依赖任务信息

被如下接口引用:ListDownstreamOpsTasks, ListUpstreamOpsTasks。

名称 类型 描述
TaskId String 任务Id
注意:此字段可能返回 null,表示取不到有效值。
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
WorkflowId String 工作流id
注意:此字段可能返回 null,表示取不到有效值。
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
Status String 任务状态:
- Y: 调度中
- F: 已下线
- O: 已暂停
- T: 下线中
- INVALID: 已失效
注意:此字段可能返回 null,表示取不到有效值。
TaskTypeId Integer 任务类型Id:
* 21:JDBC SQL
* 23:TDSQL-PostgreSQL
* 26:OfflineSynchronization
* 30:Python
* 31:PySpark
* 33:Impala
* 34:Hive SQL
* 35:Shell
* 36:Spark SQL
* 38:Shell Form Mode
* 39:Spark
* 40:TCHouse-P
* 41:Kettle
* 42:Tchouse-X
* 43:TCHouse-X SQL
* 46:DLC Spark
* 47:TiOne
* 48:Trino
* 50:DLC PySpark
* 92:MapReduce
* 130:Branch Node
* 131:Merged Node
* 132:Notebook
* 133:SSH
* 134:StarRocks
* 137:For-each
* 138:Setats SQL
注意:此字段可能返回 null,表示取不到有效值。
TaskTypeDesc String 任务类型描述
- 20 : 通用数据同步
- 25 : ETLTaskType
- 26 : ETLTaskType
- 30 : python
- 31 : pyspark
- 34 : hivesql
- 35 : shell
- 36 : sparksql
- 21 : jdbcsql
- 32 : dlc
- 33 : ImpalaTaskType
- 40 : CDWTaskType
- 41 : kettle
- 42 : TCHouse-X
- 43 : TCHouse-X SQL
- 46 : dlcsparkTaskType
- 47 : TiOneMachineLearningTaskType
- 48 : Trino
- 50 : DLCPyspark
- 23 : TencentDistributedSQL
- 39 : spark
- 92 : MRTaskType
- 38 : ShellScript
- 70 : HiveSQLScrip
- 130 : 分支
- 131 : 归并
- 132 : Notebook探索
- 133 : SSH节点
- 134 : StarRocks
- 137 : For-each
- 10000 : 自定义业务通用
注意:此字段可能返回 null,表示取不到有效值。
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
FolderId String 文件夹id
注意:此字段可能返回 null,表示取不到有效值。
FirstSubmitTime String 最近提交时间
注意:此字段可能返回 null,表示取不到有效值。
FirstRunTime String 首次运行时间
注意:此字段可能返回 null,表示取不到有效值。
ScheduleDesc String 调度计划展示描述信息
注意:此字段可能返回 null,表示取不到有效值。
CycleType String 任务周期类型
* ONEOFF_CYCLE: 一次性
* YEAR_CYCLE: 年
* MONTH_CYCLE: 月
* WEEK_CYCLE: 周
* DAY_CYCLE: 天
* HOUR_CYCLE: 小时
* MINUTE_CYCLE: 分钟
* CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
OwnerUin String 负责人
注意:此字段可能返回 null,表示取不到有效值。
ExecutionStartTime String 执行开始时间, 格式HH:mm, 如00:00
注意:此字段可能返回 null,表示取不到有效值。
ExecutionEndTime String 执行结束时间, 格式HH:mm, 如23:59
注意:此字段可能返回 null,表示取不到有效值。

OpsWorkflow

工作流列表分页详情

被如下接口引用:ListOpsWorkflows。

名称 类型 描述
TaskCount Integer 任务数量
示例值:1
FolderName String 文件名
注意:此字段可能返回 null,表示取不到有效值。
示例值:示例文件名
FolderId String 工作流文件id
示例值:91df5247-677b-11f0-9366-7c8c09fca71c
WorkflowId String 工作流id
示例值:8131486e-9274-4dac-999f-f36546325116
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
WorkflowType String 工作流类型
- cycle周期
- manual手动
示例值:cycle
WorkflowDesc String 工作流描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
OwnerUin String 负责人userId,多个‘;’隔开
注意:此字段可能返回 null,表示取不到有效值。
示例值:ryanrliao
ProjectId String 项目id
示例值:20250227112841503
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:TestProjectName
Status String 工作流状态
* ALL_RUNNING : 全部调度中
* ALL_FREEZED : 全部已暂停
* ALL_STOPPTED : 全部已下线
* PART_RUNNING : 部分调度中
* ALL_NO_RUNNING : 全部未调度
* ALL_INVALID : 全部已失效
示例值:ALL_RUNNING
CreateTime String 工作流创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-06-25 20:05:59
UpdateTime String 最近更新时间, 包含开发、生产变更
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-09-14 11:41:32
UpdateUserUin String 最近更新人,包含开发、生产变更
注意:此字段可能返回 null,表示取不到有效值。
示例值:jasonzcwang

OpsWorkflowDetail

工作流调度详情

被如下接口引用:GetOpsWorkflow。

名称 类型 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:d953cf42-6ade-4b02-825f-0a045e2c459d
WorkflowDesc String 工作流描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:demo
WorkflowType String 工作流类型:
- cycle 周期;
- manual手动
注意:此字段可能返回 null,表示取不到有效值。
示例值:cycle
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-05-09 17:47:56
CreateUserUin String 创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:vin
UpdateTime String 修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-05-09 17:47:56
StartupTime Integer 延时执行时间,unit=minute
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
StartTime String 配置生效日期 开始日期
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-11 16:36:49
EndTime String 配置结束日期 结束日期
注意:此字段可能返回 null,表示取不到有效值。
示例值:2099-12-31 23:59:59
CycleType String 任务周期类型
* ONEOFF_CYCLE: 一次性
* YEAR_CYCLE: 年
* MONTH_CYCLE: 月
* WEEK_CYCLE: 周
* DAY_CYCLE: 天
* HOUR_CYCLE: 小时
* MINUTE_CYCLE: 分钟
* CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:DAY_CYCLE
FolderId String 文件夹Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:6445aa5a-7e58-11f0-9366-7c8c09fca71c
InstanceInitStrategy String 任务实例初始化策略
- T_PLUS_1(T+1):延迟一天初始化
- T_PLUS_0(T+0):当天初始化
- T_MINUS_1(T-1):提前一天初始化
注意:此字段可能返回 null,表示取不到有效值。
示例值:T_PLUS_0
SchedulerDesc String 调度计划释义
注意:此字段可能返回 null,表示取不到有效值。
示例值:每天00:00执行一次
FirstSubmitTime String 工作流首次提交时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-06-25 20:07:15
LatestSubmitTime String 工作流最近提交时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-06-26 19:03:55
Status String 工作流状态
* ALL_RUNNING : 全部调度中
* ALL_FREEZED : 全部已暂停
* ALL_STOPPTED : 全部已下线
* PART_RUNNING : 部分调度中
* ALL_NO_RUNNING : 全部未调度
* ALL_INVALID : 全部已失效
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL_RUNNING
OwnerUin String 负责人, 多个以‘;’隔开
注意:此字段可能返回 null,表示取不到有效值。
示例值:;100042680225;
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_yulingfan

OpsWorkflows

查询工作流分页列表

被如下接口引用:ListOpsWorkflows。

名称 类型 描述
Items Array of OpsWorkflow 记录列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 结果总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
PageNumber Integer 分页页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

OrderField

通用排序字段

被如下接口引用:GetTriggerWorkflowRun, ListOpsTriggerWorkflows, ListQualityRuleGroupExecResultsByPage, ListQualityRuleGroups, ListQualityRuleGroupsTable, ListQualityRuleTemplates, ListQualityRules, ListTriggerWorkflowRuns。

名称 类型 必选 描述
Name String 排序字段名称
Direction String 排序方向:ASC|DESC

OutTaskParameter

参数传递-输出参数

被如下接口引用:CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially。

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

PageRoles

角色列表分页信息

被如下接口引用:ListProjectRoles。

名称 类型 描述
Items Array of SystemRole 角色信息
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总个数
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 总页码
注意:此字段可能返回 null,表示取不到有效值。

ParamInfo

参数

被如下接口引用:CreateTask, CreateTriggerWorkflow, CreateWorkflow, GetOpsTask, GetTask, GetTriggerWorkflow, GetWorkflow, UpdateTask, UpdateTaskPartially, UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially, UpdateWorkflow。

名称 类型 必选 描述
ParamKey String 参数名
示例值:aba
ParamValue String 参数值
示例值:cab

ParentDependencyConfigPage

查询任务上游依赖详情分页

被如下接口引用:ListUpstreamOpsTasks。

名称 类型 描述
TotalCount Integer 结果总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of OpsTaskDepend 分页数据
注意:此字段可能返回 null,表示取不到有效值。

Project

项目信息

被如下接口引用:GetProject, ListProjects。

名称 类型 描述
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
ProjectName String 项目标识,英文名
注意:此字段可能返回 null,表示取不到有效值。
DisplayName String 项目显示名称,可以为中文名
注意:此字段可能返回 null,表示取不到有效值。
Description String 备注
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Timestamp ISO8601 创建时间
注意:此字段可能返回 null,表示取不到有效值。
CreatorUin String 项目创建人id
注意:此字段可能返回 null,表示取不到有效值。
ProjectOwnerUin String 项目责任人id
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 项目状态:0:禁用,1:启用,-3:禁用中,2:启用中
ProjectModel String 项目模式,SIMPLE:简单模式 STANDARD:标准模式
注意:此字段可能返回 null,表示取不到有效值。

ProjectBrief

查询数据源分页列表

被如下接口引用:ListProjects。

名称 类型 描述
PageNumber Integer 分页页码
注意:此字段可能返回 null,表示取不到有效值。
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
Items Array of Project 数据源列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 总页码
注意:此字段可能返回 null,表示取不到有效值。

ProjectInstanceStatisticsAlarmInfo

告警规则项目波动率告警配置信息

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
AlarmType String 告警类型 

projectFailureInstanceUpwardFluctuationAlarm: 失败实例向上波动告警

projectSuccessInstanceDownwardFluctuationAlarm: 成功实例向下波动告警
示例值:projectSuccessInstanceDownwardFluctuationAlarm
InstanceThresholdCountPercent Integer 实例成功数向下波动比例告警阀值;实例失败数向上波动比例告警阀值
示例值:10
InstanceThresholdCount Integer 累计实例数波动阀值
示例值:10
StabilizeThreshold Integer 稳定性次数阈值(防抖动配置统计周期数)
示例值:1
StabilizeStatisticsCycle Integer 稳定性统计周期(防抖动配置统计周期数)
示例值:5
IsCumulant Boolean 是否累计计算,false:连续,true:累计
InstanceCount Integer 当日累计实例数;
当天失败实例数向下波动量

ProjectRequest

项目信息

被如下接口引用:CreateProject。

名称 类型 必选 描述
ProjectName String 项目标识,英文名,以字母开头,可包含字母、数字和下划线,不能超过32个字符
示例值:xiangmu1
DisplayName String 项目显示名称,可以为中文名,以字母开头,可包含字母、数字和下划线,不能超过32个字符
示例值:xiangmu1
ProjectModel String 项目模式,SIMPLE(默认):简单模式 STANDARD:标准模式
示例值:SIMPLE

ProjectResult

项目返回结果

被如下接口引用:CreateProjectMember, DeleteProject, DisableProject, EnableProject。

名称 类型 描述
Status Boolean 返回的结果 true/false

ProjectUserRole

项目的用户对象

被如下接口引用:ListProjectMembers。

名称 类型 描述
AppId String 租户id
注意:此字段可能返回 null,表示取不到有效值。
RootAccountId String 主账号id
注意:此字段可能返回 null,表示取不到有效值。
UserUin String 用户id
注意:此字段可能返回 null,表示取不到有效值。
UserName String 用户名
注意:此字段可能返回 null,表示取不到有效值。
DisplayName String 显示名称
注意:此字段可能返回 null,表示取不到有效值。
Roles Array of SystemRole 用户角色对象
注意:此字段可能返回 null,表示取不到有效值。
IsCreator Boolean 是否创建者
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
IsProjectOwner Boolean 是否项目负责人
注意:此字段可能返回 null,表示取不到有效值。
PhoneNum String 手机号
注意:此字段可能返回 null,表示取不到有效值。
Email String 邮箱
注意:此字段可能返回 null,表示取不到有效值。

ProjectUsersBrief

项目下的用户集合

被如下接口引用:ListProjectMembers。

名称 类型 描述
Items Array of ProjectUserRole 用户集合
注意:此字段可能返回 null,表示取不到有效值。
PageSize Integer 分页大小
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 分页页码
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总数量
注意:此字段可能返回 null,表示取不到有效值。
TotalPageNumber Integer 总页码
注意:此字段可能返回 null,表示取不到有效值。

QualityColumnValueConfig

字段值变量

被如下接口引用:CreateQualityRule, ModifyQualityRule。

名称 类型 必选 描述
FieldKey String 字段值key
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FieldValue String 字段值
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FieldDataType String 字段值类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityCompareRule

对比规则

被如下接口引用:CreateQualityRule, ListQualityRules, ModifyQualityRule。

名称 类型 必选 描述
Items Array of QualityCompareRuleItem 比较条件列表
注意:此字段可能返回 null,表示取不到有效值。
CycleStep Integer 周期性模板默认周期,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ComputeExpression String o 表示 或,a 表示 且,数字表示items下标
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityCompareRuleItem

比较条件

被如下接口引用:CreateQualityRule, ModifyQualityRule。

名称 类型 必选 描述
CompareType Integer 比较类型【入参必填】,1.固定值 2.波动值 3.数值范围比较 4.枚举范围比较 5.不用比较 6.字段数据相关性 7.公平性
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Operator String 比较操作类型【入参条件必填】,CompareType ∈ {1,2,6,7} 时必填
< <= == => > !=
IRLCRO:在区间内(左闭右开)
IRLORC:在区间内(左开右闭)
IRLCRC:在区间内(左闭右闭)
IRLORO:在区间内(左开右开)
NRLCRO:不在区间内(左闭右开)
NRLORC:不在区间内(左开右闭)
NRLCRC:不在区间内(左闭右闭)
NRLORO:不在区间内(左开右开)
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ValueComputeType Integer 质量统计值类型【入参条件必填】,当 CompareType ∈ {2,3,7} 时必填
可选值:
当 compareType = 2(波动值) 时:
- 1 = 绝对值(ABS)
- 2 = 上升(ASCEND)
- 3 = 下降(DESCEND)

当 compareType = 3(数值范围) 时:
- 4 = 范围内(WITH_IN_RANGE)
- 5 = 范围外(OUT_OF_RANGE)

当 compareType = 7(公平性) 时:
- 6 = 公平率(FAIRNESS_RATE)
- 7 = 公平差(FAIRNESS_GAP)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValueList Array of QualityThresholdValue 比较阈值列表【入参必填】
注意:此字段可能返回 null,表示取不到有效值。

QualityFieldConfig

字段变量

被如下接口引用:CreateQualityRule, ModifyQualityRule。

名称 类型 必选 描述
FieldKey String 字段key
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FieldValue String 字段值
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FieldDataType String 字段值类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ValueConfig QualityColumnValueConfig 字段值变量信息
注意:此字段可能返回 null,表示取不到有效值。

QualityProdSchedulerTask

数据质量生产调度任务业务实体

被如下接口引用:CreateQualityRuleGroup, ModifyQualityRuleGroup。

名称 类型 必选 描述
WorkflowId String 生产调度任务工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:49e2197f-957b-43c1-bc8f-162e6ffe9432
TaskId String 生产调度任务Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20251121143935616
TaskName String 生产调度任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1121testkkk
CycleType Integer 生产调度任务周期类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TaskType String 生产任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ScheduleTimeZone String 时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:UTC+8
InChargeIdList Array of String 负责人id
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1076342"]
InChargeNameList Array of String 负责人name
注意:此字段可能返回 null,表示取不到有效值。
示例值:["bob"]

QualityRule

数据质量规则

被如下接口引用:ListQualityRules。

名称 类型 必选 描述
RuleId Integer 规则ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleGroupId Integer 规则组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableId String 数据表Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
Name String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
Type Integer 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleTemplateId Integer 规则模板Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleTemplateContent String 规则模板概述
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
QualityDim Integer 规则所属质量维度 1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SourceObjectType Integer 规则适用的源数据对象类型(1:常量,2:离线表级,3:离线字段级别)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SourceObjectDataType Integer 规则适用的源数据对象类型(1:数值,2:字符串)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SourceObjectDataTypeName String 源字段详细类型,INT、STRING
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
SourceObjectValue String 源字段名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ConditionType Integer 检测范围 1.全表, 2.条件扫描
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ConditionExpression String 条件扫描WHERE条件表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
CustomSql String 自定义SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
CompareRule QualityCompareRule 报警触发条件
注意:此字段可能返回 null,表示取不到有效值。
AlarmLevel Integer 报警触发级别 1.低, 2.中, 3.高
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 规则描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
Operator String 规则配置人
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetDatabaseId String 目标库Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetDatabaseName String 目标库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetTableId String 目标表Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetTableName String 目标表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetConditionExpr String 目标字段过滤条件表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RelConditionExpr String 源字段与目标字段关联条件on表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FieldConfig QualityRuleFieldConfig 自定义模版sql表达式参数
注意:此字段可能返回 null,表示取不到有效值。
MultiSourceFlag Boolean 是否关联多表
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
WhereFlag Boolean 是否where参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
TemplateSql String 模版原始SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
SubQualityDim Integer 模版子维度:0.父维度类型,1.一致性: 枚举范围一致性,2.一致性:数值范围一致性,3.一致性:字段数据相关性
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TargetObjectType Integer 规则适用的目标数据对象类型(1:常量,2:离线表级,3:离线字段级别)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TargetObjectDataType Integer 规则适用的目标数据对象类型(1:数值,2:字符串)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TargetObjectDataTypeName String 目标字段详细类型,INT、STRING
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetObjectValue String 目标字段名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
SourceEngineTypes Array of Integer 源端对应的引擎类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableOwnerName String 表负责人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ExecStrategy QualityRuleGroupExecStrategy 执行策略信息
注意:此字段可能返回 null,表示取不到有效值。
Subscription QualityRuleGroupSubscribe 订阅信息
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatasourceId Integer 数据源 id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DatabaseId String 数据库 id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
MonitorStatus Integer 监控是否开启.0false,1true
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TriggerCondition String 触发条件
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DsEnvType Integer 0或者未返回或者null:未定义,1:生产,2:开发
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DatasourceType Integer 数据源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SchemaName String 模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TargetSchemaName String 目标模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatasourceName String 数据源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FailMsg String 失败原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
GroupType String 任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
AspectTaskId String 编排任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20251231160201243
CatalogName String 数据目录
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog
TargetCatalogName String 目标表的数据目录
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog

QualityRuleCreateResult

批量创建规则时的单条数据创建结果

被如下接口引用:CreateQualityRule。

名称 类型 描述
Msg String 操作结果文案
注意:此字段可能返回 null,表示取不到有效值。
示例值:创建成功
Success Boolean 操作结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Name String 规则名
注意:此字段可能返回 null,表示取不到有效值。
示例值:new_rule_5555
RuleGroupId Integer 规则组id
注意:此字段可能返回 null,表示取不到有效值。
示例值:727
RuleGroupTableId Integer 本地表id
注意:此字段可能返回 null,表示取不到有效值。
示例值:328
RuleId Integer 规则id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1001

QualityRuleExecResult

规则执行结果

被如下接口引用:ListQualityRuleGroupExecResultsByPage。

名称 类型 必选 描述
RuleExecId Integer 规则执行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:135
RuleGroupExecId Integer 规则组执行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:245
RuleGroupId Integer 规则组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:23
RuleId Integer 规则ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:43
RuleName String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testRule
RuleType Integer 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SourceObjectDataTypeName String 源字段详细类型,int string
注意:此字段可能返回 null,表示取不到有效值。
示例值:testSource
SourceObjectValue String 源字段名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testSource
ConditionExpression String 条件扫描WHERE条件表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:testExpression
ExecResultStatus Integer 检测结果(1:检测通过,2:触发规则,3:检测失败)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TriggerResult String 触发结果,告警发送成功, 阻断任务成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:result
CompareResult CompareQualityResult 对比结果
注意:此字段可能返回 null,表示取不到有效值。
TemplateName String 模版名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testTemplate
QualityDim Integer 质量维度
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TargetDBTableName String 目标表-库表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testTable
TargetObjectValue String 目标表-字段名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testObject
TargetObjectDataType String 目标表-字段类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testObject
FieldConfig QualityRuleFieldConfig 自定义模版sql表达式参数
注意:此字段可能返回 null,表示取不到有效值。
RelConditionExpr String 源字段与目标字段关联条件on表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:expre
StartTime String 执行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-10-01 22:00:00
AlarmLevel Integer 1/2/3:低/中/高
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TriggerCondition String 触发条件
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
RuleGroupName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatasourceId String 数据源ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatasourceName String 数据源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
SchemaName String 模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
RuleGroupExist Integer 判断是否屏蔽监控 0.屏蔽 1.不屏蔽
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DatasourceType Integer 数据源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleGroupTableId Integer 数据表id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
MonitorType Integer 监控方式 1.未配置, 2.关联生产调度, 3.离线周期检测
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FinishTime String 执行结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
GroupType String 监控任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:DEFAULT
AspectTaskId String 编排任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20251231160201243
CatalogName String 数据目录
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog

QualityRuleFieldConfig

规则变量替换

被如下接口引用:CreateQualityRule, ListQualityRuleGroupExecResultsByPage, ListQualityRules, ModifyQualityRule。

名称 类型 必选 描述
WhereConfig Array of QualityFieldConfig where变量
注意:此字段可能返回 null,表示取不到有效值。
TableConfig Array of QualityTableConfig 库表变量
注意:此字段可能返回 null,表示取不到有效值。

QualityRuleGroup

数据质量监控任务

被如下接口引用:ListQualityRuleGroups。

名称 类型 必选 描述
RuleGroupId Integer 规则组Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:743
DatasourceId String 数据源Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8860
DatasourceName String 数据源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:dlc_DLC_hx756s1y
DatasourceType Integer 数据源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
MonitorType Integer 监控类型 1.未配置, 2.关联生产调度, 3.离线周期检测
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-01-05 17:09:27
TableName String 关联数据表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:gee01
TableId String 关联数据表Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:64QEkwfYFHBPDWXr_7_0qg
TableOwnerName String 关联数据表负责人
注意:此字段可能返回 null,表示取不到有效值。
示例值:yaowenjie
ExecStrategy QualityRuleGroupExecStrategy 执行策略
注意:此字段可能返回 null,表示取不到有效值。
Subscription QualityRuleGroupSubscribe 订阅信息
注意:此字段可能返回 null,表示取不到有效值。
DatabaseId String 数据库id
注意:此字段可能返回 null,表示取不到有效值。
示例值:K5jTcpdZs-VEQ6lRSCzpSQ
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:at_dlc_cloud_gz_prod_mc
SchemaName String 模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
Permission Boolean 是否有权限
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
RuleCount Integer 已经配置的规则数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MonitorStatus Boolean 监控状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
TableOwnerUserId Integer 表负责人UserId
注意:此字段可能返回 null,表示取不到有效值。
示例值:700002050586
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:hw6nitfo
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-01-05 16:33:34
StrategyConfig Boolean 是否已配置执行策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SubscribeConfig Boolean 是否已配置执行策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DsEnvType Integer 数据源环境:0或者未返回.未定义,1.生产 2.开发
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterDeployType String EMR集群部署方式:CVM/TKE
注意:此字段可能返回 null,表示取不到有效值。
示例值:CVM
Name String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:mico_rule_group_101
ExecDetail String 执行详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250826201812341
PipelineTaskCount Integer 事中关联任务数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableRuleCount Integer 有效规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Description String 任务描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:create ruleGroup
CreateUserName String 监控创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:wenjieyao
GroupType String 任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:DEFAULT
AspectTaskId String 任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20260105170922315
CatalogName String 数据目录名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog

QualityRuleGroupConfig

任务配置

被如下接口引用:CreateQualityRuleGroup, ModifyQualityRuleGroup。

名称 类型 必选 描述
AnalysisType String 分析类型,可选值:
INFERENCE-推理表
TIME_SERIES-时序表
SNAPSHOT-快照表
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ModelMonitorType String 模型检测类型,分析类型为推理表(INFERENCE)时必填,可选值:
CLAASSIFICATION-分类
REGRESSION-回归
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
PredictColumn String 预测列
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
PredictColumnType String 预测列类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
LabelColumn String 标签列
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
LabelColumnType String 标签列类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ModelIdColumn String 模型id列
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ModelIdColumnType String 模型id列类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TimestampColumn String 时间戳列
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TimestampColumnType String 时间戳列类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
Granularity Integer 指标粒度
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
GranularityType String 指标粒度单位
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
BaseTable String 基准表
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
BaseDb String 基准库
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ComparisonColumn String 对比列
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ComparisonColumnType String 对比列类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ProtectionValue String 保护组
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
PositiveValue String 正类值
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FeatureColumn String 特征列
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityRuleGroupExecStrategy

质量监控任务执行策略

被如下接口引用:CreateQualityRuleGroup, ListQualityRuleGroups, ListQualityRules, ModifyQualityRuleGroup。

名称 类型 必选 描述
MonitorType Integer 监控类型 2.关联生产调度, 3.离线周期检测
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
ExecutorGroupId String 执行资源组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240222212719833743
RuleGroupName String 监控任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:mico_rule_group_101
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:at_dlc_cloud_gz_prod_mc
DatasourceId String 数据源id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8860
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:gee01
RuleGroupId Integer 监控任务的Id,编辑更新监控任务时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:738
ExecQueue String 计算队列,数据源为HIVE、ICEBERG、DLC时必填,数据源为DLC时,该字段填写DLC数据引擎名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:spark_new
ExecutorGroupName String 执行资源组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:qfh_test
Tasks Array of QualityProdSchedulerTask 关联的生产调度任务列表,MonitorType=2时必填
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 周期开始时间,MonitorType=3时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-01-05 00:00:00
EndTime String 周期结束时间,MonitorType=3时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-01-10 23:59:59
CycleType String 调度周期类型,MonitorType=3时必填,具体可填值参考:
I:按分钟调度
H:按小时调度
D:按天调度
W:按周调度
M:按月调度
注意:此字段可能返回 null,表示取不到有效值。
示例值:D
DelayTime Integer 延迟调度时间,MonitorType=3时必填,主要用于调度周期为天/周/月的任务,
计量单位为分钟,比如天任务需要延迟到02:00执行,则该字段值为120,表示延迟2小时(120分钟)
对于小时/分钟任务,该字段无意义,填固定值0,否则字段校验不通过
注意:此字段可能返回 null,表示取不到有效值。
示例值:120
CycleStep Integer 间隔,MonitorType=3时必填,表示周期任务间隔时间
周/月/天任务可选:1
分钟任务可选:10,20,30
小时任务可选:1,2,3,4,6,8,12
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TaskAction String 时间指定,主要用于调度周期为周/月的任务
调度周期为周时:含义为指定周几运行,可选多个,英文逗号隔开
可填1,2...7,依次代表周日,周一...周六,例如填“1,2”,表示周日、周一执行;

调度周期为月时,含义为指定每月的几号运行,可选多个,英文逗号隔开
可填1,2,...,31,依次代表1号,2号...31号,例如填“1,2”,表示每月的1号、2号执行
注意:此字段可能返回 null,表示取不到有效值。
示例值:1,2
ExecEngineType String 运行的执行引擎,不传时会请求该数据源下默认的执行引擎
注意:此字段可能返回 null,表示取不到有效值。
示例值:DLC
ExecPlan String 执行计划
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RuleId Integer 规则id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1081
RuleName String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:new_rule_55555
TriggerTypes Array of String 触发类型,主要用于“关联生产调度”(MonitorType=2)的监控任务,可选值:
CYCLE:周期调度
MAKE_UP:补录
RERUN:重跑
注意:此字段可能返回 null,表示取不到有效值。
示例值:["CYCLE", "MAKE_UP", "RERUN"]
DlcGroupName String 数据源为DLC时,对应DLC资源组,根据ExecQueue中填的DLC引擎名称,选择对应引擎下的资源组
注意:此字段可能返回 null,表示取不到有效值。
示例值:default-rg-17tv8vfgvy
SchemaName String schema名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:sc_1
Description String 任务描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:create ruleGroup
ScheduleTimeZone String 时区,默认为UTC+8
注意:此字段可能返回 null,表示取不到有效值。
示例值:UTC+8
GroupConfig QualityRuleGroupConfig 任务监控参数
注意:此字段可能返回 null,表示取不到有效值。
EngineParam String 引擎参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:--executor-cores 1 --executor-memory 1G --num-executors 1 --driver-cores 1 --driver-memory 1G
CatalogName String 数据目录名称,不填默认为DataLakeCatalog(更新质量监控时该参数无效)
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog

QualityRuleGroupPage

质量监控分页

被如下接口引用:ListQualityRuleGroups。

名称 类型 描述
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Items Array of QualityRuleGroup 质量监控列表
注意:此字段可能返回 null,表示取不到有效值。

QualityRuleGroupResult

任务创建结果

被如下接口引用:CreateQualityRuleGroup。

名称 类型 必选 描述
Id Integer 任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Name String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
RuleGroupTableId Integer 监控表id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DatasourceId String 数据源ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
SchemaName String 模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
MonitorType Integer 监控类型:1.未配置, 2.关联生产调度, 3.离线周期检测
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExecDetail String 执行描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FailMsg String 失败原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
CatalogName String 数据目录名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityRuleGroupSubscribe

数据质量规则组订阅信息

被如下接口引用:ListQualityRuleGroups, ListQualityRules。

名称 类型 必选 描述
RuleGroupId Integer 规则组Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Receivers Array of QualitySubscribeReceiver 订阅接收人列表
注意:此字段可能返回 null,表示取不到有效值。
SubscribeType Array of Integer 订阅方式 1.邮件email 2.短信sms
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
WebHooks Array of QualitySubscribeWebHook 群机器人配置的webhook信息
注意:此字段可能返回 null,表示取不到有效值。
RuleId Integer 规则Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleName String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
AlarmMessageRule String 发送对象
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityRuleGroupTableV2

规则表

被如下接口引用:ListQualityRuleGroupsTable。

名称 类型 必选 描述
Id Integer id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleGroupId Integer 规则组id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableId String 表id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
SchemaName String 模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
TableOwnerUserId Integer 表负责人id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableOwnerName String 表负责人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatasourceId String 数据源id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatasourceName String 数据源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatabaseId String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
DatasourceType Integer 数据源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InstanceId String 实例id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
RuleGroupCount Integer 监控数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RuleCount Integer 规则数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult
EnableRuleGroupCount Integer 生效监控数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CatalogName String 数据目录名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testResult

QualityRuleGroupsTableVO

规则组分页

被如下接口引用:ListQualityRuleGroupsTable。

名称 类型 描述
TotalCount Integer 记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of QualityRuleGroupTableV2 监控对象列表
注意:此字段可能返回 null,表示取不到有效值。

QualityRuleInfo

数据质量规则

被如下接口引用:CreateQualityRule。

名称 类型 必选 描述
Name String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:new_rule_5555
Type Integer 规则类型
1:系统模版
2:自定义模版
3:自定义SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DatasourceId String 数据源Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8860
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:at_dlc_cloud_gz_prod_mc
CompareRule QualityCompareRule 报警触发条件
注意:此字段可能返回 null,表示取不到有效值。
AlarmLevel Integer 报警触发级别 1.低, 2.中, 3.高
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
SourceEngineTypes Array of Integer 该规则支持的执行引擎列表,可选值如下:
1 - MYSQL
2 - HIVE
4 - SPARK
8 - LIVY
16 - DLC
32 - GBASE
64 - TCHouse-P
128 - DORIS
256 - TCHouse-D
512 - EMR_STARROCKS
1024 - TCHouse-X
注意:此字段可能返回 null,表示取不到有效值。
示例值:[16]
TableName String 表名称,TableId和TableName至少填一个
注意:此字段可能返回 null,表示取不到有效值。
示例值:gee01
RuleTemplateId Integer 规则模板id,【条件必填】当Type≠3(自定义SQL)时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:6142
QualityDim Integer 规则所属质量维度,Type=3(自定义SQL)时必填(1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1470547050521227264
RuleGroupId Integer 规则组Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:727
TableId String 数据表ID,TableId和TableName至少要有一个
注意:此字段可能返回 null,表示取不到有效值。
示例值:125
SourceObjectDataTypeName String 源数据对象(表、字段等)详细类型,【条件必填】当Type=1(系统模板)时必填
表对应固定值“table”(模板是表级的)
字段则是对应字段类型:int、string等(模板是字段级的)
注意:此字段可能返回 null,表示取不到有效值。
示例值:table
SourceObjectValue String 源数据对象(表、字段等)名称,【条件必填】当Type=1(系统模板)时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:表
ConditionType Integer 检测范围,【条件必填】当Type=1(系统模板)或2(自定义模板)时必填。
1.全表
2.条件扫描
注意:CompareType为2(波动值)或 使用用户自定义模板时包含过滤条件${FILTER}时,检测范围必须为2条件扫描
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ConditionExpression String 条件扫描WHERE条件表达式,【条件必填】ConditionType=2(条件扫描)时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:1=1
CustomSql String 自定义SQL(Base64编码),【条件必填】Type=3(自定义SQL)时必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:c2VsZWN0ICogZnJvbSB0YjE=
Description String 规则描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:row count
DatabaseId String 数据库Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
TargetDatabaseId String 目标库Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
TargetTableId String 目标表Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:171
TargetConditionExpr String 目标过滤条件表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1=1
RelConditionExpr String 源字段与目标字段关联条件on表达式,【条件必填】仅在字段数据相关性规则时必填(ruleTemplate中qualityDim=4(一致性) 且 subQualityDim=3(字段数据相关性)),例如sourceTable.model_id=targetTable.model_id
注意:此字段可能返回 null,表示取不到有效值。
示例值:tb1.name=tb2.name
FieldConfig QualityRuleFieldConfig 自定义模版sql表达式字段替换参数,【条件必填】Type=2(自定义模板)时必填
注意:此字段可能返回 null,表示取不到有效值。
TargetObjectValue String 目标字段名称 CITY
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
Index String 下标,新增时区分不同数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:50464ee-6775-7037-4e0a-c02ae7baf8d
SchemaName String 模式名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
TargetSchemaName String 目标schema名称,【条件必填】仅在系统模板的“字段数据相关性”规则以及数据源为TCHouse-P时必填(ruleTemplate的qualityDim=4 且 subQualityDim=3)。用于校验和关联跨表数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
TargetDatabaseName String 目标库名称,【条件必填】仅在系统模板的“字段数据相关性”规则时必填(ruleTemplate的qualityDim=4 且 subQualityDim=3)。用于校验和关联跨表数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:db_1
TargetTableName String 目标表名称,【条件必填】仅在系统模板的“字段数据相关性”规则时必填(ruleTemplate的qualityDim=4 且 subQualityDim=3)。用于校验和关联跨表数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:tb2
TaskId String 任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:202309110827
CatalogName String 数据目录名称,主要用于dlc数据源
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog
TargetCatalogName String 目标数据目录名称,【条件必填】仅在系统模板的“字段数据相关性”规则以及数据源为DLC时必填(ruleTemplate的qualityDim=4 且 subQualityDim=3)。用于校验和关联跨表数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:DataLakeCatalog

QualityRulePage

数据质量规则分页

被如下接口引用:ListQualityRules。

名称 类型 必选 描述
TotalCount Integer 记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of QualityRule 规则列表
注意:此字段可能返回 null,表示取不到有效值。

QualityRuleTemplate

规则模版

被如下接口引用:ListQualityRuleTemplates。

名称 类型 描述
RuleTemplateId Integer 规则模版ID
示例值:1
Name String 规则模版名称
示例值:testParameter
Description String 规则模版描述
示例值:testParameter
Type Integer 模版类型(1:系统模版,2:自定义)
示例值:1
SourceObjectType Integer 规则适用的源数据对象类型(1:常量,2:离线表级,3:离线字段级别)
示例值:1
SourceObjectDataType Integer 规则适用的源数据对象类型(1:数值,2:字符串)
示例值:1
SourceContent String 规则模版源侧内容,区分引擎,JSON 结构
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
SourceEngineTypes Array of Integer 源数据适用类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
QualityDim Integer 规则所属质量维度(1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CompareType Integer 规则支持的比较方式类型(1:固定值比较,大于、小于,大于等于等 2:波动值比较,绝对值、上升、下降)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CitationCount Integer 引用次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UserId Integer 创建人id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UserName String 创建人昵称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
UpdateTime String 更新时间yyyy-MM-dd HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
WhereFlag Boolean 是否添加where参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
MultiSourceFlag Boolean 是否关联多个库表
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SqlExpression String 自定义模板SQL表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
SubQualityDim Integer 模版子维度,0.父维度类型,1.一致性: 枚举范围一致性,2.一致性:数值范围一致性,3.一致性:字段数据相关性
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ResolvedSqlExpression QualitySqlExpression sql表达式解析对象
注意:此字段可能返回 null,表示取不到有效值。
DatasourceTypes Array of Integer 支持的数据源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
UserIdStr String 创建人IdStr
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityRuleTemplatePage

RuleTemplatePage 结果

被如下接口引用:ListQualityRuleTemplates。

名称 类型 描述
TotalCount Integer 记录数
示例值:10
Items Array of QualityRuleTemplate 模版列表

QualitySqlExpression

数据质量自定义规则时的sql表达式解析对象

被如下接口引用:ListQualityRuleTemplates。

名称 类型 描述
TableExpressions Array of QualitySqlExpressionTable sql表达式表名
注意:此字段可能返回 null,表示取不到有效值。
ParamExpressions Array of String sql表达式字段名
注意:此字段可能返回 null,表示取不到有效值。
示例值:["testParameter"]
SystemTemplateExpressions Array of String 新增模型检测类系统模板sql中占位符集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:["testParameter"]

QualitySqlExpressionTable

数据质量自定义规则时的sql表达式解析表对象

被如下接口引用:ListQualityRuleTemplates。

名称 类型 描述
TableExpression String sql表达式表名
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ColumnExpression Array of String sql表达式字段名
注意:此字段可能返回 null,表示取不到有效值。
示例值:["testParameter"]

QualitySubscribeReceiver

订阅接收人

被如下接口引用:ListQualityRuleGroups, ListQualityRules。

名称 类型 必选 描述
ReceiverUserId Integer 接收人Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ReceiverName String 接收人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
ReceiverUserIdStr String 接收人Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualitySubscribeWebHook

群机器人订阅配置

被如下接口引用:ListQualityRuleGroups, ListQualityRules。

名称 类型 必选 描述
HookType String 群机器人类型,当前支持飞书
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
HookAddress String 群机器人webhook地址,配置方式参考https://cloud.tencent.com/document/product/1254/70736
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

QualityTableConfig

规则表变量替换

被如下接口引用:CreateQualityRule, ModifyQualityRule。

名称 类型 必选 描述
DatabaseId String 数据库Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableId String 表Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
TableKey String 表Key
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter
FieldConfig Array of QualityFieldConfig 字段变量
注意:此字段可能返回 null,表示取不到有效值。

QualityThresholdValue

数据质量阈值

被如下接口引用:CreateQualityRule, ListQualityRuleGroupExecResultsByPage, ModifyQualityRule。

名称 类型 必选 描述
ValueType Integer 阈值类型【入参必填】 1.低阈值 2.高阈值 3.普通阈值 4.枚举值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Value String 阈值【入参必填】
注意:此字段可能返回 null,表示取不到有效值。
示例值:testParameter

ReconciliationStrategyInfo

离线集成对账告警规则

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
RuleType String 离线告警规则类型
reconciliationFailure: 离线对账失败告警
reconciliationOvertime: 离线对账任务运行超时告警(需配置超时时间)
reconciliationMismatch: 离线对账不一致条数告警(需配置不一致条数阀值)
注意:此字段可能返回 null,表示取不到有效值。
MismatchCount Integer 对账不一致条数阀值, RuleType=reconciliationMismatch对账不一致条数类型,需要配置该字段,无默认值
注意:此字段可能返回 null,表示取不到有效值。
Hour Integer 对账任务运行超时阀值: 小时, 默认为0
注意:此字段可能返回 null,表示取不到有效值。
Min Integer 对账任务运行超时阀值: 分钟, 默认为1
注意:此字段可能返回 null,表示取不到有效值。

RelateTask

数据源相关任务

被如下接口引用:GetDataSourceRelatedTasks。

名称 类型 描述
TaskType String 任务类型

- OfflineIntegration --- 离线集成任务
- RealtimeIntegration --- 实时集成任务
- DataDevelopment --- 数据开发任务
- DataQuality --- 数据质量任务
- DataService --- 数据服务任务
- MetadataCollection --- 元数据采集任务
示例值:OfflineIntegration
TaskNum Integer 任务数量
TaskList Array of BriefTask 任务详情
注意:此字段可能返回 null,表示取不到有效值。

ResourceFile

资源文件详情

被如下接口引用:GetResourceFile。

名称 类型 描述
ProjectId String 项目ID
示例值:1531609696090365952
ResourceId String 资源文件ID
示例值:ec921143-2fb0-435d-b646-5c8e964e1a05
ResourceName String 资源文件名称
LocalPath String 资源文件路径
示例值:/datast1udio/resource/1625
RemotePath String 资源对象COS存储路径
示例值:/datast1udio/resource/1
FileExtensionType String 资源文件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:zip
Size String 资源大小
示例值:1MB
CreatorUserUin String 创建用户ID
CreatorUserName String 创建用户名称
UpdateUserName String 最后更新用户名称
注意:此字段可能返回 null,表示取不到有效值。
UpdateUserUin String 最后更新用户ID
注意:此字段可能返回 null,表示取不到有效值。
BucketName String COS 桶
示例值:xb-bj-13150517
CosRegion String COS 地域
示例值:ap-beijing
ResourceSourceMode String 资源来源模式
示例值:UPLOAD_MODE
BundleId String 本地工程ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:11
BundleInfo String 本地工程信息
注意:此字段可能返回 null,表示取不到有效值。

ResourceFileItem

获取资源文件列表item

被如下接口引用:ListResourceFiles。

名称 类型 描述
ResourceId String 资源文件ID
示例值:1531609696090365952
ResourceName String 资源文件名称
示例值:wedata.json
FileExtensionType String 资源文件类型
示例值:zip
LocalPath String 资源路径
示例值:aaaaa/qw/wedata.json

ResourceFilePage

资源文件分页

被如下接口引用:ListResourceFiles。

名称 类型 描述
Items Array of ResourceFileItem 任务集合信息
TotalPageNumber Integer 总页数
示例值:1
TotalCount Integer 总数量
示例值:1
PageNumber Integer 当前页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页显示数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

ResourceFolder

资源文件夹详情

被如下接口引用:ListResourceFolders。

名称 类型 描述
FolderId String 资源文件夹ID
CreateUserUin String 创建人ID
CreateUserName String 创建人名称
FolderPath String 文件夹路径
FolderName String 文件夹名称

ResourceFolderDetail

资源文件夹详情

被如下接口引用:GetResourceFolder。

名称 类型 描述
FolderId String 资源文件夹ID
示例值:c214c7d4-f617-11ee-8ec8-b8599f277de5
CreateUserUin String 创建人ID
示例值:100029386028
CreateUserName String 创建人名称
示例值:spir
FolderPath String 文件夹路径
示例值:/a/b
FolderName String 文件夹名称
示例值:b
ParentFolderPath String 父文件夹绝对路径,不包含文件名夹名
示例值:/a
ProjectId String 项目id
示例值:1460947878944567296

ResourceFolderPage

资源文件夹分页

被如下接口引用:ListResourceFolders。

名称 类型 描述
Items Array of ResourceFolder 资源文件夹集合信息
TotalPageNumber Integer 总页数
示例值:1
TotalCount Integer 总数量
示例值:5
PageNumber Integer 当前页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页显示数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

ResourceGroupMetrics

资源组监控指标

被如下接口引用:GetResourceGroupMetrics。

名称 类型 描述
CpuNum Integer 资源组规格相关:cpu个数
注意:此字段可能返回 null,表示取不到有效值。
DiskVolume Integer 资源组规格相关:磁盘规格
注意:此字段可能返回 null,表示取不到有效值。
MemSize Integer 资源组规格相关:内存大小,单位:G
注意:此字段可能返回 null,表示取不到有效值。
LifeCycle Integer 资源组生命周期, 单位:天
注意:此字段可能返回 null,表示取不到有效值。
MaximumConcurrency Integer 资源组规格相关:最高并发
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 资源组状态

- 0 --- 初始化中
- 1 --- 运行中
- 2 --- 运行异常
- 3 --- 释放中
- 4 --- 已释放
- 5 --- 创建中
- 6 --- 创建失败
- 7 --- 更新中
- 8 --- 更新失败
- 9 --- 已到期
- 10 --- 释放失败
- 11 --- 使用中
- 12 --- 未使用
注意:此字段可能返回 null,表示取不到有效值。
MetricSnapshots Array of MetricData 指标详情

ResourceGroupSpecification

资源组规格

被如下接口引用:CreateResourceGroup。

名称 类型 必选 描述
Specification String 资源组规格
Number Integer 数量

ResourceNumber

操作资源包数量

被如下接口引用:UpdateResourceGroup。

名称 类型 必选 描述
Type String 增加/减少枚举

- ADD -- 增加
- DELETE -- 减少
示例值:ADD
Quantity Integer 增加/减少资源包的数量
示例值:1

ResourceResult

资源组操作结果

被如下接口引用:CreateResourceGroup。

名称 类型 描述
Status Boolean 是否成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ResourceGroupId String 资源组id
注意:此字段可能返回 null,表示取不到有效值。
示例值:123457

ResourceStatus

资源组操作状态

被如下接口引用:AssociateResourceGroupToProject, DeleteResourceGroup, DissociateResourceGroupFromProject, UpdateResourceGroup。

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

ResourceType

开通的资源组信息

被如下接口引用:CreateResourceGroup。

名称 类型 必选 描述
ResourceGroupType String 资源组类型

- Schedule --- 调度资源组
- Integration --- 集成资源组
- DataService -- 数据服务资源组
示例值:Schedule
Integration IntegrationResource 集成资源组,细分实时资源组和离线资源组(集成、调度、数据服务资源组不可以同时购买)
Schedule ResourceGroupSpecification 调度资源组(集成、调度、数据服务资源组不可以同时购买)

- s_test(测试规格)
- s_small(基础规格)
- s_medium(普及规格)
- s_large(专业规格)


DataService ResourceGroupSpecification 数据服务资源组(集成、调度、数据服务资源组不可以同时购买)

- ds_t(测试规格)
- ds_s(基础规格)
- ds_m(普及规格)
- ds_l(专业规格)

SQLContentActionResult

SQL探索文件/文件夹操作结果

被如下接口引用:DeleteSQLFolder, DeleteSQLScript, UpdateSQLFolder。

名称 类型 描述
Status Boolean 操作是否成功
注意:此字段可能返回 null,表示取不到有效值。
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。

SQLFolderNode

SQL脚本文件树节点

被如下接口引用:GetSQLFolder, ListSQLFolderContents。

名称 类型 描述
Id String 唯一标识
注意:此字段可能返回 null,表示取不到有效值。
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
Type String 类型 folder,script
注意:此字段可能返回 null,表示取不到有效值。
ParentFolderPath String 父文件夹path,/aaa/bbb/ccc
注意:此字段可能返回 null,表示取不到有效值。
IsLeaf Boolean 是否叶子节点
注意:此字段可能返回 null,表示取不到有效值。
Params String 业务参数
注意:此字段可能返回 null,表示取不到有效值。
AccessScope String 权限范围: SHARED, PRIVATE
注意:此字段可能返回 null,表示取不到有效值。
Path String 节点路径
注意:此字段可能返回 null,表示取不到有效值。
CreateUserUin String 创建人
注意:此字段可能返回 null,表示取不到有效值。
NodePermission String 当前用户对节点拥有的权限
注意:此字段可能返回 null,表示取不到有效值。
Children Array of SQLFolderNode 子节点列表
注意:此字段可能返回 null,表示取不到有效值。
OwnerUin String 文件责任人
注意:此字段可能返回 null,表示取不到有效值。

SQLScript

数据探索脚本业务处理实体

被如下接口引用:CreateSQLScript, GetSQLScript, UpdateSQLScript。

名称 类型 描述
ScriptId String 脚本id
注意:此字段可能返回 null,表示取不到有效值。
ScriptName String 脚本名称
注意:此字段可能返回 null,表示取不到有效值。
OwnerUin String 脚本所有者 uin
注意:此字段可能返回 null,表示取不到有效值。
ParentFolderPath String 父文件夹path,/aaa/bbb/ccc
注意:此字段可能返回 null,表示取不到有效值。
ScriptConfig SQLScriptConfig 脚本配置
注意:此字段可能返回 null,表示取不到有效值。
ScriptContent String 脚本内容
注意:此字段可能返回 null,表示取不到有效值。
UpdateUserUin String 最近一次操作人
注意:此字段可能返回 null,表示取不到有效值。
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间 yyyy-MM-dd hh:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间 yyyy-MM-dd hh:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
AccessScope String 权限范围:SHARED, PRIVATE
注意:此字段可能返回 null,表示取不到有效值。
Path String 节点全路径,/aaa/bbb/ccc.ipynb,由各个节点的名称组成
注意:此字段可能返回 null,表示取不到有效值。

SQLScriptConfig

数据探索脚本配置

被如下接口引用:CreateSQLScript, GetSQLScript, UpdateSQLScript。

名称 类型 必选 描述
DatasourceId String 数据源Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:9584
DatasourceEnv String 数据源环境
注意:此字段可能返回 null,表示取不到有效值。
示例值:development
ComputeResource String 计算资源
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
ExecutorGroupId String 执行资源组
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240102201245028277
Params String 高级运行参数,变量替换,map-json String,String
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"userSSL": true}
AdvanceConfig String 高级设置,执行配置参数,map-json String,String. 采用Base64编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ExecutorSize":"medium","ExecutorNumbers":20,"ExecutorMaxNumbers":null,"DriverSize":"small","Type":"0"}

SQLStopResult

停止sql运行结果

被如下接口引用:StopSQLScriptRun。

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

SchedulingParameter

任务调度变量参数

被如下接口引用:RerunTriggerWorkflowRunAsync。

名称 类型 必选 描述
ParamKey String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
ParamValue String 参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:testNameVal
ExtProperties String 拓展参数json
注意:此字段可能返回 null,表示取不到有效值。
示例值:"{}"

SchemaInfo

Schema信息

被如下接口引用:ListSchema。

名称 类型 必选 描述
Guid String Schema GUID
注意:此字段可能返回 null,表示取不到有效值。
Name String Schema名称
注意:此字段可能返回 null,表示取不到有效值。
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。

SqlCreateResult

创建数据探索脚本文件夹返回类

被如下接口引用:CreateSQLFolder。

名称 类型 必选 描述
FolderId String 文件夹id
注意:此字段可能返回 null,表示取不到有效值。
示例值:wer25267

StartTasks

批量启动任务返回参数

被如下接口引用:StartOpsTasks。

名称 类型 描述
Status Boolean 任务启动是否成功
示例值:true

SubmitTaskResult

提交数据开发任务结果

被如下接口引用:SubmitTask, SubmitTriggerTask。

名称 类型 描述
VersionId String 生成的任务版本ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:203437477419_243242348237
Status Boolean 提交状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

SystemRole

角色对象

被如下接口引用:ListProjectMembers, ListProjectRoles, ListTenantRoles。

名称 类型 描述
RoleId String 角色id
RoleName String 角色名称
注意:此字段可能返回 null,表示取不到有效值。
RoleDisplayName String 角色展示名
注意:此字段可能返回 null,表示取不到有效值。
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。

TableInfo

数据库信息

被如下接口引用:GetTable, ListTable。

名称 类型 必选 描述
Guid String 数据表GUID
注意:此字段可能返回 null,表示取不到有效值。
Name String 数据表名称
注意:此字段可能返回 null,表示取不到有效值。
Description String 数据表描述
注意:此字段可能返回 null,表示取不到有效值。
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
SchemaName String 数据库Schema名称
注意:此字段可能返回 null,表示取不到有效值。
TableType String 表类型
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
TechnicalMetadata TechnicalMetadata 表的技术元数据
注意:此字段可能返回 null,表示取不到有效值。
BusinessMetadata BusinessMetadata 表的业务元数据
注意:此字段可能返回 null,表示取不到有效值。

Task

任务对象

被如下接口引用:GetOpsTask, GetTask, GetTaskVersion。

名称 类型 必选 描述
TaskBaseAttribute TaskBaseAttribute 任务基本属性
注意:此字段可能返回 null,表示取不到有效值。
TaskConfiguration TaskConfiguration 任务配置
注意:此字段可能返回 null,表示取不到有效值。
TaskSchedulerConfiguration TaskSchedulerConfiguration 任务调度配置
注意:此字段可能返回 null,表示取不到有效值。

TaskBaseAttribute

任务基本属性信息

被如下接口引用:GetOpsTask, GetTask, ListTasks。

名称 类型 必选 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:250814213724
TaskTypeId Integer 任务类型ID:

* 21:JDBC SQL
* 23:TDSQL-PostgreSQL
* 26:OfflineSynchronization
* 30:Python
* 31:PySpark
* 33:Impala
* 34:Hive SQL
* 35:Shell
* 36:Spark SQL
* 38:Shell Form Mode
* 39:Spark
* 40:TCHouse-P
* 41:Kettle
* 42:Tchouse-X
* 43:TCHouse-X SQL
* 46:DLC Spark
* 47:TiOne
* 48:Trino
* 50:DLC PySpark
* 92:MapReduce
* 130:Branch Node
* 131:Merged Node
* 132:Notebook
* 133:SSH
* 134:StarRocks
* 137:For-each
* 138:Setats SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:30
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:185c35d4-958e-4574-9f6c-3eca00b95870
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:task_01
TaskLatestVersionNo String 最近一次保存版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V1
TaskLatestSubmitVersionNo String 最近一次提交版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V1
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf_01
Status String 任务状态:
* N: 新建
* Y: 调度中
* F: 已下线
* O: 已暂停
* T: 下线中
* INVALID: 已失效
注意:此字段可能返回 null,表示取不到有效值。
示例值:N
Submit Boolean 任务最新提交状态,任务是否已经提交:true/false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
CreateTime String 任务创建时间,示例:2022-02-12 11:13:41
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-02-12 11:13:41
LastUpdateTime String 最后更新时间,示例:2025-08-13 16:34:06
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 17:27:58
LastUpdateUserName String 最后更新人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:zhanglin
LastOpsTime String 最后运维时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 17:27:58
LastOpsUserName String 最后运维人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:zhanglin
OwnerUin String 任务负责人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
TaskDescription String 任务描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test task!
UpdateUserUin String 最近一次更新用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
CreateUserUin String 创建用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
TaskFolderPath String 任务文件夹路径

注意:
- 路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
- 如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;
注意:此字段可能返回 null,表示取不到有效值。
示例值:/tf_01

TaskCode

任务代码

被如下接口引用:GetOpsTaskCode。

名称 类型 描述
CodeContent String 代码内容
CodeFileSize Integer 代码文件大小,单位bytes

TaskCodeResult

任务代码

被如下接口引用:GetTaskCode, GetTriggerTaskCode。

名称 类型 描述
CodeInfo String 代码内容
注意:此字段可能返回 null,表示取不到有效值。
CodeFileSize String 代码文件大小,单位KB
注意:此字段可能返回 null,表示取不到有效值。

TaskConfiguration

任务配置信息

被如下接口引用:GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially。

名称 类型 必选 描述
CodeContent String 代码内容的Base64编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:c2VsZWN0IDE=
TaskExtConfigurationList Array of TaskExtParameter 任务扩展属性配置列表
注意:此字段可能返回 null,表示取不到有效值。
DataCluster String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:emr-kvo70628
BrokerIp String 指定的运行节点
注意:此字段可能返回 null,表示取不到有效值。
示例值:any
YarnQueue String 资源池队列名称,需要通过 DescribeProjectClusterQueues 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:queue
SourceServiceId String 来源数据源ID, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:100647
SourceServiceType String 来源数据源类型, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:setats
SourceServiceName String 来源数据源名称, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:Setats_cluster-0yswvrky
TargetServiceId String 目标数据源ID, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:100648
TargetServiceType String 目标数据源类型, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:setats
TargetServiceName String 目标数据源名称, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:Setats_cluster-0yswvrkx
ResourceGroup String 资源组ID: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId
注意:此字段可能返回 null,表示取不到有效值。
示例值:20230112132636530791
ResourceGroupName String 资源组名称: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupName
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_rg1
TaskSchedulingParameterList Array of TaskSchedulingParameter 调度参数
注意:此字段可能返回 null,表示取不到有效值。
BundleId String Bundle使用的ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:525793f2-8425-4238-af46-c5caea381a5e
BundleInfo String Bundle信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"bundleName":"bundle名称","bundlePath":"bundle路径"}

TaskDataRegistry

任务数据库登记项

被如下接口引用:CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially。

名称 类型 必选 描述
DatasourceId String 数据源ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:9588
DatabaseName String 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:a0a0a
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:baseline_features
PartitionName String 分区名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
DataFlowType String 输入输出表类型
输入流
UPSTREAM,
输出流
DOWNSTREAM;
注意:此字段可能返回 null,表示取不到有效值。
示例值:UPSTREAM
TablePhysicalId String 表物理唯一ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1315051759-ap-beijing-null-DLC-DataLakeCatalog-a0a0a-null-baseline_features
DbGuid String 库唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:250910180035
TableGuid String 表唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:250910180037

TaskDependDto

依赖任务信息

被如下接口引用:ListDownstreamTasks, ListUpstreamTasks。

名称 类型 描述
TaskId String 任务Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250918205013913
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
WorkflowId String 工作流id
注意:此字段可能返回 null,表示取不到有效值。
示例值:834671df-e995-43ab-86cf-8fd422a7ec3f
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:workflow_name
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1464962169590902784
Status String 任务状态:
- Y: 运行
- F: 停止
- O: 冻结
- T: 停止中
- INVALID: 已失效
注意:此字段可能返回 null,表示取不到有效值。
示例值:Y
TaskTypeId Integer 任务类型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:35
TaskTypeDesc String 任务类型描述
- 20 : 通用数据同步
- 25 : ETLTaskType
- 26 : ETLTaskType
- 30 : python
- 31 : pyspark
- 34 : hivesql
- 35 : shell
- 36 : sparksql
- 21 : jdbcsql
- 32 : dlc
- 33 : ImpalaTaskType
- 40 : CDWTaskType
- 41 : kettle
- 42 : TCHouse-X
- 43 : TCHouse-X SQL
- 46 : dlcsparkTaskType
- 47 : TiOneMachineLearningTaskType
- 48 : Trino
- 50 : DLCPyspark
- 23 : TencentDistributedSQL
- 39 : spark
- 92 : MRTaskType
- 38 : ShellScript
- 70 : HiveSQLScrip
- 130 : 分支
- 131 : 归并
- 132 : Notebook探索
- 133 : SSH节点
- 134 : StarRocks
- 137 : For-each
- 10000 : 自定义业务通用
注意:此字段可能返回 null,表示取不到有效值。
示例值:shell任务
ScheduleDesc String 调度计划展示描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:从2025年08月21日 00:00:00开始,每天00:00~23:59内,每间隔5分钟执行一次
StartTime String 任务开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-07-31 21:11:24
EndTime String 任务结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-07-31 21:11:24
DelayTime Integer 延迟时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:120
CycleType String 周期类型:默认为 D

支持的类型为

* O: 一次性
* Y: 年
* M: 月
* W: 周
* D: 天
* H: 小时
* I: 分钟
* C: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:D
OwnerUin String 负责人
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578763
TaskAction String 弹性周期配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InitStrategy String 调度初始化策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:T+1
CrontabExpression String crontab表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:0 0 0 0 1 0

TaskExtParameter

任务扩展信息参数

被如下接口引用:CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially。

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

TaskFolder

任务文件夹信息

被如下接口引用:ListTaskFolders。

名称 类型 描述
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1576328529015705600
TaskFolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a63aef9a-f37b-11ef-8d13-a4ae120f8272
TaskFolderPath String 文件夹绝对路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/zl
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:251112212650

TaskFolderDetail

任务文件夹详细信息

被如下接口引用:GetTaskFolder。

名称 类型 描述
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1576328529015705600
TaskFolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a63aef9a-f37b-11ef-8d13-a4ae120f8272
TaskFolderPath String 文件夹绝对路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/0_zl/case_for
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:251112221655
ParentTaskFolderPath String 父文件夹绝对路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/0_zl
TaskFolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:case_for
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:d9e9f6d6-70b2-40e1-b5a5-a8d178103ccf
TaskFolderType String 任务文件夹类型

| 任务文件夹类型取值 | 任务文件夹类型界面对应名称 |
| ---------------- | ------------------------ |
| ETL | 集成任务 |
| EMR | EMR |
| DLC | DLC |
| SETATS | SETATS |
| TDSQL | TDSQL |
| TCHOUSE | TCHOUSE |
| GENERAL | 通用 |
| TI_ONE | TI-ONE机器学习 |
| ACROSS_WORKFLOWS | 跨工作流 |

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

TaskFolderPage

任务文件夹分页

被如下接口引用:ListTaskFolders。

名称 类型 描述
PageNumber Integer 数据页数,大于等于1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页显示的数据条数,最小为10条,最大为200 条
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 文件夹总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
TotalPageNumber Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of TaskFolder 文件夹列表
注意:此字段可能返回 null,表示取不到有效值。

TaskInstance

调度任务实例实体

被如下接口引用:ListDownstreamTaskInstances, ListTaskInstances, ListUpstreamTaskInstances。

名称 类型 描述
ProjectId String 所属项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2763518183736183934
InstanceKey String 实例唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240627201611119_2025-03-20 00:00:00
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f7418cc8-84f8****
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testFolder
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ba48d170-3239***
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cron_test_wf
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240627201611119
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cron_test
CurRunDate String 实例数据时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:00
InstanceState String 实例状态
- WAIT_EVENT: 等待事件
- WAIT_UPSTREAM: 等待上游
- WAIT_RUN: 等待运行
- RUNNING: 运行中
- SKIP_RUNNING: 跳过运行
- FAILED_RETRY: 失败重试
- EXPIRED: 失败
- COMPLETED: 成功
注意:此字段可能返回 null,表示取不到有效值。
InstanceType Integer 实例类型

- 0 表示补录类型
- 1 表示周期实例
- 2 表示非周期实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OwnerUinList Array of String 负责人列表
注意:此字段可能返回 null,表示取不到有效值。
TotalRunNum Integer 累计运行次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TaskType String 任务类型描述
TaskTypeId Integer 任务类型id
注意:此字段可能返回 null,表示取不到有效值。
CycleType String 任务周期类型
支持过滤多个,条件间为 或 的过滤关系
* O: ONEOFF_CYCLE
* Y: YEAR_CYCLE
* M: MONTH_CYCLE
* W: WEEK_CYCLE
* D: DAY_CYCLE
* H: HOUR_CYCLE
* I: MINUTE_CYCLE
* C: CRONTAB_CYCLE
注意:此字段可能返回 null,表示取不到有效值。
TryLimit Integer 每次运行失败,下发重试次数限制
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Tries Integer 失败重试次数
再次使用 手动重跑 或 补录实例等方式触发运行时,会被重置为 0 后重新计数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StartTime String 运行开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:01
EndTime String 运行完成时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:11
CostTime Integer 耗费时间, 单位ms
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
SchedulerTime String 计划调度时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:00
LastUpdateTime String 实例最近更新时间, 时间格式为 yyyy-MM-dd HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-19 00:00:00
ExecutorGroupId String 执行资源组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240821154428723333
ExecutorGroupName String 资源组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试资源组

TaskInstanceDetail

调度任务实例详情

被如下接口引用:GetTaskInstance。

名称 类型 描述
ProjectId String 所属项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2763518183736183934
InstanceKey String 实例唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240627201611119_2025
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f7418cc8-84f8****
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testFolder
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ba48d170-3239***
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cron_test_wf
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240627201611119
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cron_test
TaskTypeId Integer taskType对应的id
示例值:32
TaskType String 任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:SHELL
CycleType String 任务周期类型
* ONEOFF_CYCLE: 一次性
* YEAR_CYCLE: 年
* MONTH_CYCLE: 月
* WEEK_CYCLE: 周
* DAY_CYCLE: 天
* HOUR_CYCLE: 小时
* MINUTE_CYCLE: 分钟
* CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:YEAR_CYCLE
CurRunDate String 实例数据时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:00
InstanceState String 实例状态
- WAIT_EVENT: 等待事件
- WAIT_UPSTREAM: 等待上游
- WAIT_RUN: 等待运行
- RUNNING: 运行中
- SKIP_RUNNING: 跳过运行
- FAILED_RETRY: 失败重试
- EXPIRED: 失败
- COMPLETED: 成功
注意:此字段可能返回 null,表示取不到有效值。
InstanceType Integer 实例类型

- 0 表示补录类型
- 1 表示周期实例
- 2 表示非周期实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OwnerUinList Array of String 负责人列表
注意:此字段可能返回 null,表示取不到有效值。
TotalRunNum Integer 累计运行次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TryLimit Integer 每次运行失败,下发重试次数限制
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Tries Integer 失败重试次数
再次使用 手动重跑 或 补录实例等方式触发运行时,会被重置为 0 后重新计数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CostTime Integer 耗费时间, 单位ms
注意:此字段可能返回 null,表示取不到有效值。
示例值:11
StartTime String 运行开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:01
EndTime String 运行完成时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:11
SchedulerTime String 计划调度时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-20 00:00:00
LastUpdateTime String 实例最近更新时间, 时间格式为 yyyy-MM-dd HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-03-19 00:00:00
ExecutorGroupId String 执行资源组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240821154428723333
ExecutorGroupName String 资源组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试资源组
JobErrorMsg String 简要的任务失败信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:用户代码和执行环境存在异常

TaskInstanceExecutions

任务实例执行列表

被如下接口引用:ListTaskInstanceExecutions。

名称 类型 描述
TotalCount Integer 结果总数
TotalPageNumber Integer 总页数
Items Array of InstanceExecution 记录列表
PageNumber Integer 页码
PageSize Integer 分页大小

TaskInstancePage

实例列表分页实体

被如下接口引用:ListDownstreamTaskInstances, ListTaskInstances, ListUpstreamTaskInstances。

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalPageNumber Integer 总分页数
注意:此字段可能返回 null,表示取不到有效值。
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条目数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of TaskInstance 数据列表
注意:此字段可能返回 null,表示取不到有效值。

TaskOpsInfo

任务运维工作流列表详情

被如下接口引用:ListOpsTasks。

名称 类型 描述
TaskId String 任务ID
示例值:20250725151016827
TaskName String 任务名
示例值:test_task
OwnerUin String 负责人Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028448913
Status String 任务状态:
- Y: 调度中
- F: 已下线
- O: 已暂停
- T: 下线中
- INVALID: 已失效
示例值:N
FolderId String 文件夹id
示例值:e0609ae9-2ab8-4ffe-b46b-95e4352df281
FolderName String 文件夹名字
示例值:test_folder
WorkflowId String 工作流id
示例值:a091bc68-cfcc-4c78-b6c0-c34dd0173d22
WorkflowName String 工作流名称
示例值:test_work_flow_name
ProjectId String 项目id
示例值:1460947878144537296
ProjectName String 项目名称
示例值:调度demo项目
UpdateUserUin String 更新人名称
示例值:100036013191
TaskTypeId Integer 任务类型Id:
* 21:JDBC SQL
* 23:TDSQL-PostgreSQL
* 26:OfflineSynchronization
* 30:Python
* 31:PySpark
* 33:Impala
* 34:Hive SQL
* 35:Shell
* 36:Spark SQL
* 38:Shell Form Mode
* 39:Spark
* 40:TCHouse-P
* 41:Kettle
* 42:Tchouse-X
* 43:TCHouse-X SQL
* 46:DLC Spark
* 47:TiOne
* 48:Trino
* 50:DLC PySpark
* 92:MapReduce
* 130:Branch Node
* 131:Merged Node
* 132:Notebook
* 133:SSH
* 134:StarRocks
* 137:For-each
* 138:Setats SQL
示例值:26
TaskTypeDesc String 任务类型描述
- 通用数据同步
- ETLTaskType
- ETLTaskType
- python
- pyspark
- HiveSQLTaskType
- shell
- SparkSQLTaskType
- JDBCSQLTaskType
- DLCTaskType
- ImpalaTaskType
- CDWTaskType
- kettle
- DLCSparkTaskType
- TiOne机器学习
- TrinoTaskType
- DLCPyspark
- spark
- mr
- shell脚本
- hivesql脚本
- 自定义业务通用
注意:此字段可能返回 null,表示取不到有效值。
示例值:Shell
CycleType String 任务周期类型
* ONEOFF_CYCLE: 一次性
* YEAR_CYCLE: 年
* MONTH_CYCLE: 月
* WEEK_CYCLE: 周
* DAY_CYCLE: 天
* HOUR_CYCLE: 小时
* MINUTE_CYCLE: 分钟
* CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:DAY_CYCLE
ExecutorGroupId String 资源组id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20230302191306287347
ScheduleDesc String 调度描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:从2024年06月18日 00:00:00开始,每天00:00~23:59内,每间隔5分钟执行一次
ExecutorGroupName String 资源组名称
示例值:集成资源组-test
LastSchedulerCommitTime String 最新调度提交时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-07-25 15:10:28
FirstRunTime String 首次执行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-04-17 00:00:00
FirstSubmitTime String 最近一次提交时间
示例值:2024-07-11 23:51:23
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-07-25 15:10:19
LastUpdateTime String 最近更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024-07-11 23:51:23

TaskSchedulerConfiguration

任务调度配置信息

被如下接口引用:GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially。

名称 类型 必选 描述
CycleType String 周期类型:支持的类型为

ONEOFF_CYCLE: 一次性
YEAR_CYCLE: 年
MONTH_CYCLE: 月
WEEK_CYCLE: 周
DAY_CYCLE: 天
HOUR_CYCLE: 小时
MINUTE_CYCLE: 分钟
CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:DAY_CYCLE
ScheduleTimeZone String 时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:UTC+8
CrontabExpression String 0 2 3 1,L,2 * ?
注意:此字段可能返回 null,表示取不到有效值。
示例值:Cron表达式
StartTime String 生效日期
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-07-30 00:00:00
EndTime String 结束日期
注意:此字段可能返回 null,表示取不到有效值。
示例值:2099-12-31 23:59:59
ExecutionStartTime String 执行时间 左闭区间
注意:此字段可能返回 null,表示取不到有效值。
示例值:00:00
ExecutionEndTime String 执行时间 右闭区间
注意:此字段可能返回 null,表示取不到有效值。
示例值:23:59
CalendarOpen String 日历调度 取值为 0 和 1, 1为打开,0为关闭,默认为0
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CalendarId String 日历调度 日历 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:720
CalendarName String 日历调度 日历名称, 需要从 DescribeScheduleCalendarPageList 中获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:交易所日历
SelfDepend String 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序)
注意:此字段可能返回 null,表示取不到有效值。
示例值:serial
UpstreamDependencyConfigList Array of DependencyTaskBrief 上游依赖数组
注意:此字段可能返回 null,表示取不到有效值。
DownstreamDependencyConfigList Array of DependencyTaskBrief 下游依赖数组
注意:此字段可能返回 null,表示取不到有效值。
EventListenerList Array of EventListener 事件数组
注意:此字段可能返回 null,表示取不到有效值。
AllowRedoType String 重跑&补录配置, 默认为 ALL; , ALL 运行成功或失败后皆可重跑或补录, FAILURE 运行成功后不可重跑或补录,运行失败后可重跑或补录, NONE 运行成功或失败后皆不可重跑或补录;
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL
ParamTaskOutList Array of OutTaskParameter 输出参数数组
注意:此字段可能返回 null,表示取不到有效值。
ParamTaskInList Array of InTaskParameter 输入参数数组
注意:此字段可能返回 null,表示取不到有效值。
TaskOutputRegistryList Array of TaskDataRegistry 产出登记
注意:此字段可能返回 null,表示取不到有效值。
InitStrategy String 实例生成策略
* T_PLUS_0: T+0生成,默认策略
* T_PLUS_1: T+1生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:T_PLUS_0
ScheduleType Integer 调度类型: 0 正常调度 1 空跑调度,默认为 0
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RunPriorityType Integer 任务调度优先级 运行优先级 4高 5中 6低 , 默认:6
注意:此字段可能返回 null,表示取不到有效值。
示例值:6
RetryWaitMinute Integer 重试策略 重试等待时间,单位分钟: 默认: 5
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
MaxRetryNumber Integer 重试策略 最大尝试次数, 默认: 4
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
ExecutionTTLMinute Integer 超时处理策略 运行耗时超时(单位:分钟)默认为 -1
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
WaitExecutionTotalTTLMinute Integer 超时处理策略 等待总时长耗时超时(单位:分钟)默认为 -1
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1

TaskSchedulingParameter

任务调度变量参数

被如下接口引用:CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially。

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

TaskVersion

任务版本列表信息

被如下接口引用:ListTaskVersions。

名称 类型 描述
CreateTime String 保存时间
注意:此字段可能返回 null,表示取不到有效值。
VersionNum String 版本号
注意:此字段可能返回 null,表示取不到有效值。
CreateUserUin String 创建人
注意:此字段可能返回 null,表示取不到有效值。
VersionId String 保存版本id
注意:此字段可能返回 null,表示取不到有效值。
VersionRemark String 版本描述信息
注意:此字段可能返回 null,表示取不到有效值。
ApproveStatus String 审批状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
Status String 生产状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
ApproveUserUin String 审批人(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。

TaskVersionDetail

任务版本列表信息

被如下接口引用:GetTaskVersion。

名称 类型 描述
CreateTime String 保存时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-26 15:28:52
VersionNum String 版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V30
CreateUserUin String 版本创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578753
VersionId String 保存版本Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250723102549746_20250826152851866
VersionRemark String 版本描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:11
ApproveStatus String 审批状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:REJECT
ApproveTime String 生产状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-26 15:28:52
Task Task 版本的任务详情
注意:此字段可能返回 null,表示取不到有效值。
ApproveUserUin String 审批人Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578753

TechnicalMetadata

TechnicalMetadata

被如下接口引用:GetTable, ListTable。

名称 类型 必选 描述
Owner String 责任人
注意:此字段可能返回 null,表示取不到有效值。
Location String 数据表位置
注意:此字段可能返回 null,表示取不到有效值。
StorageSize Integer 存储大小
注意:此字段可能返回 null,表示取不到有效值。

TimeOutStrategyInfo

告警超时配置规则信息

被如下接口引用:CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule。

名称 类型 必选 描述
RuleType Integer 超时告警超时配置:

1.预计运行耗时超时,2.预计完成时间超时,3.预计等待调度耗时超时,4.预计周期内完成但实际未完成
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Type Integer 超时值配置类型

1--指定值
2--平均值
注意:此字段可能返回 null,表示取不到有效值。
Hour Integer 超时指定值小时, 默认 为0
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Min Integer 超时指定值分钟, 默认为1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ScheduleTimeZone String 超时时间对应的时区配置, 如 UTC+7, 默认为UTC+8
注意:此字段可能返回 null,表示取不到有效值。
示例值:UTC+7
Second Integer 秒(用于 Spark Streaming 策略)
注意:此字段可能返回 null,表示取不到有效值。
Times Integer 次数(用于 Spark Streaming 重试次数超限策略,ruleType=10)
注意:此字段可能返回 null,表示取不到有效值。
AlarmTriggerFrequency Integer 告警触发频率(用于 Spark Streaming 策略 ruleType=8/9/10)
* 单位:分钟,范围:5-1440
* 告警触发后,在该时间内暂停检测,避免告警风暴
注意:此字段可能返回 null,表示取不到有效值。

TrendData

资源组指标趋势

被如下接口引用:GetResourceGroupMetrics。

名称 类型 描述
Timestamp Integer 时间戳
Value Integer 指标值

TriggerDependencyConfigPage

查询任务上游依赖详情分页

被如下接口引用:ListDownstreamTriggerTasks, ListUpstreamTriggerTasks。

名称 类型 描述
TotalCount Integer 满足查询条件的数据总条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPageNumber Integer 满足查询条件的数据总页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageNumber Integer 当前请求的数据页数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 当前请求的数据页条数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
Items Array of TriggerTaskDependDto 分页数据
注意:此字段可能返回 null,表示取不到有效值。

TriggerTask

任务对象

被如下接口引用:GetTriggerTask, GetTriggerTaskVersion。

名称 类型 必选 描述
TriggerTaskBaseAttribute TriggerTaskBaseAttribute 任务基本属性
注意:此字段可能返回 null,表示取不到有效值。
TriggerTaskConfiguration TriggerTaskConfiguration 任务配置
注意:此字段可能返回 null,表示取不到有效值。
TriggerTaskSchedulerConfiguration TriggerTaskSchedulerConfiguration 任务调度配置
注意:此字段可能返回 null,表示取不到有效值。

TriggerTaskBaseAttribute

任务基本属性信息

被如下接口引用:GetTriggerTask, ListTriggerTasks。

名称 类型 必选 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:250814213724
TaskTypeId Integer 任务类型ID:

- 26:OfflineSynchronization
- 30:Python
- 32:DLC SQL
- 35:Shell
- 38:Shell Form Mode
- 46:DLC Spark
- 50:DLC PySpark
- 130:Branch Node
- 131:Merged Node
- 132:Notebook
- 133:SSH
- 137:For-each
- 139:DLC Spark Streaming
- 140:Run Workflow
注意:此字段可能返回 null,表示取不到有效值。
示例值:35
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:185c35d4-958e-4574-9f6c-3eca00b95870
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:task_01
TaskLatestVersionNo String 最近一次保存版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V1
TaskLatestSubmitVersionNo String 最近一次提交的版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V1
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf_01
Status String 任务状态:
* N: 新建
* Y: 调度中

注意:此字段可能返回 null,表示取不到有效值。
示例值:N
Submit Boolean 任务最新提交状态,任务是否已经提交:true/false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
CreateTime String 任务创建时间,示例:2022-02-12 11:13:41
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-02-12 11:13:41
LastUpdateTime String 最后更新时间,示例:2025-08-13 16:34:06
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-02-12 11:13:41
LastUpdateUserName String 最后更新人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:zhanglin
LastOpsTime String 最后运维时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 17:27:58
LastOpsUserName String 最后运维人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:zhanglin
OwnerUin String 任务负责人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
TaskDescription String 任务描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test task!
UpdateUserUin String 最近一次更新用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
CreateUserUin String 创建用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
TaskFolderPath String 任务文件夹路径

注意:

路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;
注意:此字段可能返回 null,表示取不到有效值。
示例值:/tf_01

TriggerTaskBrief

任务概要信息

被如下接口引用:GetOpsTriggerWorkflow。

名称 类型 描述
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:12093485602
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_name
WorkflowId String 工作流id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1fac4126-507b-4649-8bca-8d2176701d20
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf-name
TaskId String 任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0b174412-403a-444f-abeb-cd710f3bd586
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:tk-name
TaskType String 任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:NOTEBOOK
UserUinInCharge String 责任人user UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:2830456
UserNameInCharge String 责任人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:zhangsan
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:9iu74412-403a-4n4f-abeb-chdf3bd586
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:fd-name
TaskTypeId Integer 任务类型ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:26
ExecutionState String 任务状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
ExecutionStartTime String 运行开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:"1765984067097"

TriggerTaskConfiguration

任务配置信息

被如下接口引用:GetTriggerTask, UpdateTriggerTask, UpdateTriggerTaskPartially。

名称 类型 必选 描述
CodeContent String 代码内容的Base64编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:c2VsZWN0IDE=
TaskExtConfigurationList Array of TaskExtParameter 任务扩展属性配置列表
注意:此字段可能返回 null,表示取不到有效值。
DataCluster String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:emr-kvo70628
BrokerIp String 指定的运行节点
注意:此字段可能返回 null,表示取不到有效值。
示例值:any
YarnQueue String 资源池队列名称,需要通过 DescribeProjectClusterQueues 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:queue
SourceServiceId String 来源数据源ID, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:100647
SourceServiceType String 来源数据源类型, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:setats
SourceServiceName String 来源数据源名称, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:Setats_cluster-0yswvrky
TargetServiceId String 目标数据源ID, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:100648
TargetServiceType String 目标数据源类型, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:setats
TargetServiceName String 目标数据源名称, 需要通过 DescribeDataSourceWithoutInfo 获取
注意:此字段可能返回 null,表示取不到有效值。
示例值:Setats_cluster-0yswvrkx
ResourceGroup String 资源组ID: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId
注意:此字段可能返回 null,表示取不到有效值。
示例值:20230112132636530791
ResourceGroupName String 资源组名称: 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupName
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_rg1
TaskSchedulingParameterList Array of TaskSchedulingParameter 调度参数
注意:此字段可能返回 null,表示取不到有效值。
BundleId String Bundle使用的ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:525793f2-8425-4238-af46-c5caea381a5e
BundleInfo String Bundle信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"bundleName":"bundle名称","bundlePath":"bundle路径"}

TriggerTaskDAGBrief

工作流任务概要信息

被如下接口引用:GetOpsTriggerWorkflow。

名称 类型 描述
TriggerTasks Array of TriggerTaskBrief 任务信息合集
注意:此字段可能返回 null,表示取不到有效值。
TriggerTaskLinks Array of TriggerTaskLinkBrief 任务连接信息合集
注意:此字段可能返回 null,表示取不到有效值。

TriggerTaskDependDto

依赖的工作流调度任务信息

被如下接口引用:ListDownstreamTriggerTasks, ListUpstreamTriggerTasks。

名称 类型 描述
TaskId String 任务Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250918205013913
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
WorkflowId String 工作流id
注意:此字段可能返回 null,表示取不到有效值。
示例值:834671df-e995-43ab-86cf-8fd422a7ec3f
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:workflow_name
ProjectId String 项目id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1464962169590902784
Status String 任务状态:
- Y: 运行
- N: 新建

注意:此字段可能返回 null,表示取不到有效值。
示例值:Y
TaskTypeId Integer 任务类型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:35
TaskTypeDesc String 任务类型描述
- 20 : 通用数据同步
- 25 : ETLTaskType
- 26 : ETLTaskType
- 30 : python
- 31 : pyspark
- 34 : hivesql
- 35 : shell
- 36 : sparksql
- 21 : jdbcsql
- 32 : dlc
- 33 : ImpalaTaskType
- 40 : CDWTaskType
- 41 : kettle
- 42 : TCHouse-X
- 43 : TCHouse-X SQL
- 46 : dlcsparkTaskType
- 47 : TiOneMachineLearningTaskType
- 48 : Trino
- 50 : DLCPyspark
- 23 : TencentDistributedSQL
- 39 : spark
- 92 : MRTaskType
- 38 : ShellScript
- 70 : HiveSQLScrip
- 130 : 分支
- 131 : 归并
- 132 : Notebook探索
- 133 : SSH节点
- 134 : StarRocks
- 137 : For-each
- 10000 : 自定义业务通用
注意:此字段可能返回 null,表示取不到有效值。
示例值:shell任务
OwnerUin String 负责人
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578763

TriggerTaskLinkBrief

任务链接概要信息

被如下接口引用:GetOpsTriggerWorkflow。

名称 类型 描述
LinkId String 连接ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0664f425-a5d8-40ef-bba1-1084526f392d
WorkflowId String 所属工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:777320ff-6ac7-43fc-9dbc-1ffdf36b99ff
WorkflowVersionId String 所属工作流版本ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:c893e-40-4269-6757c-d6yusda9
UpstreamTaskId String 上游任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:2e994925-a1d0-4648-8133-2361d7c95fb7
DownstreamTaskId String 下游任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:c9e3aa3e-0000-4829-857c-5d16516ea553

TriggerTaskRunBrief

工作流调度模式下的任务运行概要信息

被如下接口引用:GetTriggerTaskRun, GetTriggerWorkflowRun。

名称 类型 描述
ExecutionId String 任务运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:o1byd46si972c5y7rt
ExecutionState String 执行状态,运行失败:FAILED、运行成功:SUCCESS、等待中:PENDING、跳过运行:SKIP、运行中:RUNNING
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:158746972540691
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a1s746si972c540c6om91
WorkflowExecutionId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:b1sd46si972c5yme
TaskId String 任务 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a1s746si972c540c6om91
TaskType String 任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:AutoGen
TaskVersionId String 任务版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:fsfsdfgdfgfdgf
TriggerType String 触发类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:dryRun
WaitTime String 等待时长,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:826
ResourceGroup String 所属资源组
注意:此字段可能返回 null,表示取不到有效值。
示例值:fsdgdgfht
ErrorCode String 错误码
注意:此字段可能返回 null,表示取不到有效值。
示例值:Cancelled
ExecuteUserUin String 运行账号
注意:此字段可能返回 null,表示取不到有效值。
示例值:760115600
CreaterUin String 创建人 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:760115600
JobId String 执行平台执行 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:23543658
CreateTime String 创建时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
UpdateTime String 更新时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
DependenceFinishedTime String 依赖任务完成时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
QueueStartTime String 任务下发执行平台时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
PendingStartTime String 开始等待资源时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
ExecutionStartTime String 运行开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
ExecutionEndTime String 运行结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
QueueCostTime String 排队时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
ExecutionTime String 运行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
AllCostTime String 总花费时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1760338224444
TimeZone String 时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:utc+8
DependOnList Array of String 依赖上游任务 ID 列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["task_id1", "task_id2"]
RunParams String 运行参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:"['key':'value']"
TaskTypeExtensions String 任务扩展信息,包含脚本路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"key_id", "value_str"}
RetryTimes Integer 重试次数,为 0 则表示首次运行
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
LeftCoordinate Float 左侧坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.0
TopCoordinate Float 顶部坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.0
ResourceGroupId String 资源组 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:dgdfhfjmkjnk
ErrorCodeStr String 错误码描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:无效参数
CreateUin String 创建人 UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:2944356
IssueTime String 下发执行平台时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:13543050367
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testname
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf-name
ExecuteUserName String 运行人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testname
RerunTimes Integer 重跑次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsLatestExecution Boolean 是否是最新一次运行
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
TaskExecutionState String 任务运行状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
CycleType String 周期类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:ONEOFF_CYCLE
UserNameInCharge String 责任人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试人
UserUinInCharge String 责任人id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2321
ResourceGroupName String 资源组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:资源组task
Timezone String 时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:Asia/shanghai
FolderId String 文件夹id
注意:此字段可能返回 null,表示取不到有效值。
示例值:24234
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:文件夹AAA
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wedata
TaskTypeId Integer 任务类型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:26
WorkflowParams String 工作流运行参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"aa":"aa"}
SupportRerun Boolean 是否支持重跑
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
WorkflowExecutionState String 工作流运行状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
ExecutionResult String 任务执行结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"workflowExecutionId":"bcb186f6-286b-40f6-be08-2543466307eb"}

TriggerTaskSchedulerConfiguration

任务调度配置信息

被如下接口引用:GetTriggerTask, UpdateTriggerTask, UpdateTriggerTaskPartially。

名称 类型 必选 描述
UpstreamDependencyConfigList Array of DependencyTriggerTaskBrief 上游依赖数组
注意:此字段可能返回 null,表示取不到有效值。
RunPriorityType Integer 任务调度优先级 运行优先级 4高 5中 6低 , 默认:6
注意:此字段可能返回 null,表示取不到有效值。
示例值:6
RetryWaitMinute Integer 重试策略 重试等待时间,单位分钟: 默认: 5
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
MaxRetryNumber Integer 重试策略 最大尝试次数, 默认: 4
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
ExecutionTTLMinute Integer 超时处理策略 运行耗时超时(单位:分钟)默认为 -1
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
WaitExecutionTotalTTLMinute Integer 超时处理策略 等待总时长耗时超时(单位:分钟)默认为 -1
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
AllowRedoType String 重跑&补录配置, 默认为 ALL; , ALL 运行成功或失败后皆可重跑或补录, FAILURE 运行成功后不可重跑或补录,运行失败后可重跑或补录, NONE 运行成功或失败后皆不可重跑或补录;
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL
ParamTaskOutList Array of OutTaskParameter 输出参数数组
注意:此字段可能返回 null,表示取不到有效值。
ParamTaskInList Array of InTaskParameter 输入参数数组
注意:此字段可能返回 null,表示取不到有效值。
TaskOutputRegistryList Array of TaskDataRegistry 产出登记
注意:此字段可能返回 null,表示取不到有效值。

TriggerTaskVersion

任务版本列表信息

被如下接口引用:ListTriggerTaskVersions。

名称 类型 描述
CreateTime String 保存时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 14:48:32
VersionNum String 版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V41
CreateUserUin String 创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579606
VersionId String 保存版本id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0250723102549746_20250827144832136
VersionRemark String 版本描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:132
ApproveStatus String 审批状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:Approval in progress
Status String 生产状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:Y
ApproveUserUin String 审批人(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579606

TriggerTaskVersionDetail

任务版本列表信息

被如下接口引用:GetTriggerTaskVersion。

名称 类型 描述
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-26 15:28:52
VersionNum String 版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:V30
CreateUserUin String 版本创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578753
VersionId String 保存版本Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:20250723102549746_20250826152851866
VersionRemark String 版本描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:11
ApproveStatus String 审批状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:REJECT
ApproveTime String 生产状态(只有提交版本有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-26 15:28:52
ApproveUserUin String 审批人Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578753
Task TriggerTask 版本的任务详情
注意:此字段可能返回 null,表示取不到有效值。

TriggerWorkflowBrief

工作流概要信息

被如下接口引用:ListOpsTriggerWorkflows。

名称 类型 描述
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:12945864667
WorkflowId String 工作ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:dsa45njnkj534
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf
TaskCount Integer 任务数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:324324234
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:fd
WorkflowTriggerConfig WorkflowTriggerConfig 调度配置
注意:此字段可能返回 null,表示取不到有效值。
UserNameInCharge String 责任人
注意:此字段可能返回 null,表示取不到有效值。
示例值:testname
UserUinInCharge String 责任人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:380230526
WorkflowParams String 工作流参数
示例值:{"param":"value"}"

TriggerWorkflowDetail

查询工作流详细信息

被如下接口引用:GetTriggerWorkflow。

名称 类型 描述
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:hour_to_一次性
OwnerUin String 责任人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100029705957
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100029705957
WorkflowParams Array of ParamInfo 工作流参数数组
注意:此字段可能返回 null,表示取不到有效值。
TriggerWorkflowSchedulerConfigurations Array of WorkflowTriggerConfig 统一调度参数
注意:此字段可能返回 null,表示取不到有效值。
WorkflowDesc String 工作流描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述信息
Path String 工作流所属路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/keyl_p0_test/hour_to_一次性
BundleId String BundleId项
注意:此字段可能返回 null,表示取不到有效值。
示例值:be4b6673-96da-4402-beae-a89dbc4d627b
BundleInfo String BundleInfo项
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"aaa":"bbb"}
GeneralTaskParams Array of WorkflowGeneralTaskParam 通用参数
注意:此字段可能返回 null,表示取不到有效值。
SchedulerStatus String Trigger 状态 启动ACTIVE,暂停PAUSED
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE

TriggerWorkflowInfo

获取工作流的列表信息item

被如下接口引用:ListTriggerWorkflows。

名称 类型 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:be4b6673-96da-4402-beae-a89dbc4d627b
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
OwnerUin String 负责人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-02-12 11:13:41
ModifyTime String 最新修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 17:27:58
UpdateUserUin String 最后更新人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801
WorkflowDesc String 工作流描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test workflow!
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028579801

TriggerWorkflowResult

工作流列表查询

被如下接口引用:ListOpsTriggerWorkflows。

名称 类型 描述
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TotalPageNumber Integer 页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of TriggerWorkflowBrief 工作流信息集合
注意:此字段可能返回 null,表示取不到有效值。

TriggerWorkflowRunBrief

工作流运行概要信息

被如下接口引用:GetTriggerWorkflowRun, ListTriggerWorkflowRuns。

名称 类型 描述
AppId String 用户AppId
注意:此字段可能返回 null,表示取不到有效值。
示例值:1394028945
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1359789
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:wf_test
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:5dbb66d3-a4ca-4a45-9836
ExecutionId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:89dty66d3-a4ca-4aa45-9805
TriggerId String 触发器ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:02cfb302-4175-4a74-9238-15f044dff4b7
TriggerType String 触发方式:调度触发Scheduler、手动触发ManualTrigger、事件触发Event
注意:此字段可能返回 null,表示取不到有效值。
示例值:Scheduler
CreateTime String 工作流触发时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
ExecutionStartTime String 执行开始时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
ExecutionEndTime String 执行结束时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
ExecutionCostTime String 运行时长,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:291
QueueCostTime String 并发排队花费时间,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:267
PendingCostTime String 等待资源花费时间,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:759
ExecutionState String 执行状态,运行失败:FAILED、运行成功:SUCCESS、等待中:PENDING、跳过运行:SKIPED、运行中:RUNNING
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
ExecuteUserUin String 运行用户UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:623423
ExecuteUserName String 运行用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testName
ErrorCodeStr String 错误码
注意:此字段可能返回 null,表示取不到有效值。
示例值:UserCanceled
WorkflowParams String 运行参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:"['key':'value']"
WorkflowVersionId String 工作流版本信息ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ksi5dbb66d3
SupportRerun Boolean 是否支持重跑
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
RerunTimes Integer 重跑次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SelectedTaskIds Array of String 运行的任务范围,逗号分隔的任务ID列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["dsd5d67ad8a"]
PendingStartTime String 等待并发开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
QueueStartTime String 排队等待开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
EndTime String 运行结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
FolderId String 文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ghsopjbkjxbkj
FolderName String 文件夹名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:TEST
PlannedSchedulingTime String 计划调度时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1761201295754
CycleType String 周期类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:ONEOFF_CYCLE
UserNameInCharge String 责任人名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试人
UserUinInCharge String 责任人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:3231

TriggerWorkflowRunResult

查询工作流结果

被如下接口引用:ListTriggerWorkflowRuns。

名称 类型 描述
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
TotalPageNumber Integer 页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
PageNumber Integer 页码
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 页大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Items Array of TriggerWorkflowRunBrief 工作流运行以及相关任务运行信息集合
注意:此字段可能返回 null,表示取不到有效值。

TriggerWorkflowTaskRunDetailBrief

工作流任务运行详情

被如下接口引用:GetTriggerWorkflowRun。

名称 类型 描述
TriggerWorkflowRun TriggerWorkflowRunBrief 工作流运行信息
TriggerTaskRuns Array of TriggerTaskRunBrief 任务运行信息
BizStateEnumInfos Array of BizStateEnumInfoBrief 业务状态枚举信息

UpdateFolderResult

更新文件夹结果

被如下接口引用:UpdateResourceFolder, UpdateWorkflowFolder。

名称 类型 描述
Status Boolean 更新状态,true表示更新成功,false表示更新失败

UpdateResourceFileResult

更新资源文件结果

被如下接口引用:UpdateResourceFile。

名称 类型 描述
Status Boolean true

UpdateTaskBaseAttribute

更新任务基本属性信息

被如下接口引用:UpdateTask。

名称 类型 必选 描述
TaskName String 任务名称
示例值:sh_241204_111248
OwnerUin String 任务负责人ID
示例值:100028579801
TaskDescription String 任务描述
示例值:this is a task
TaskFolderPath String 注意:
- 路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
- 如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;
示例值:/tf_01

UpdateTaskBaseAttributePart

更新任务基本属性信息

被如下接口引用:UpdateTaskPartially。

名称 类型 必选 描述
TaskName String 任务名称
示例值:testupdatepart
OwnerUin String 任务负责人ID
示例值:1315051789
TaskDescription String 任务描述
示例值:新任务
TaskFolderPath String 注意:
- 路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
- 如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;
示例值:任务文件夹路径

UpdateTaskBrief

更新任务对象入参

被如下接口引用:UpdateTask。

名称 类型 必选 描述
TaskBaseAttribute UpdateTaskBaseAttribute 任务基本属性
TaskConfiguration TaskConfiguration 任务配置
TaskSchedulerConfiguration TaskSchedulerConfiguration 任务调度配置

UpdateTaskFolderResult

更新文件夹结果

被如下接口引用:UpdateTaskFolder。

名称 类型 描述
Status Boolean 更新状态,true表示更新成功,false表示更新失败
示例值:true

UpdateTaskPart

更新任务对象入参

被如下接口引用:UpdateTaskPartially。

名称 类型 必选 描述
TaskBaseAttribute UpdateTaskBaseAttributePart 任务基本属性
TaskConfiguration TaskConfiguration 任务配置
TaskSchedulerConfiguration TaskSchedulerConfiguration 任务调度配置

UpdateTaskResult

更新任务返回体

被如下接口引用:UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially。

名称 类型 描述
Status Boolean 处理结果,成功返回 true,不成功返回 false
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

UpdateTasksOwner

批量修改任务负责人结果

被如下接口引用:UpdateOpsTasksOwner。

名称 类型 描述
Status Boolean 修改任务责任人结果
示例值:true

UpdateTriggerTaskBaseAttribute

更新任务基本属性信息

被如下接口引用:UpdateTriggerTask。

名称 类型 必选 描述
TaskName String 任务名称
示例值:sh_241204_111248
OwnerUin String 任务负责人ID
示例值:100028579801
TaskDescription String 任务描述
示例值:this is a task
TaskFolderPath String 注意:
- 路径上不要填写任务节点类型;例如,在 一个名为 wf01 的工作流,“通用” 分类下,现在想要在这个分类下的 tf_01 文件夹下,新建一个 shell 任务;则 填写 /tf_01 即可;
- 如果 tf_01 文件夹不存在,则需要先创建这个文件夹(使用 CreateTaskFolder 接口)才能操作成功;
示例值:/tf_01

UpdateTriggerTaskBaseAttributePart

更新任务基本属性信息

被如下接口引用:UpdateTriggerTaskPartially。

名称 类型 必选 描述
TaskName String 任务名称
OwnerUin String 任务负责人ID
TaskDescription String 任务描述

UpdateTriggerTaskBrief

更新任务对象入参

被如下接口引用:UpdateTriggerTask。

名称 类型 必选 描述
TriggerTaskBaseAttribute UpdateTriggerTaskBaseAttribute 任务基本属性
TriggerTaskConfiguration TriggerTaskConfiguration 任务配置
TriggerTaskSchedulerConfiguration TriggerTaskSchedulerConfiguration 任务调度配置

UpdateTriggerTaskPart

更新任务对象入参

被如下接口引用:UpdateTriggerTaskPartially。

名称 类型 必选 描述
TriggerTaskBaseAttribute UpdateTriggerTaskBaseAttributePart 任务基本属性
TriggerTaskConfiguration TriggerTaskConfiguration 任务配置
TriggerTaskSchedulerConfiguration TriggerTaskSchedulerConfiguration 任务调度配置

UpdateTriggerWorkflowPartially

查询工作流详细信息

被如下接口引用:UpdateTriggerWorkflowPartially。

名称 类型 必选 描述
WorkflowName String 工作流名称
示例值:name
OwnerUin String 责任人ID
示例值:123453453
WorkflowParams Array of ParamInfo 工作流参数数组
TriggerWorkflowSchedulerConfigurations Array of WorkflowTriggerConfig 统一调度参数
WorkflowDesc String 工作流描述
示例值:工作流描述
BundleId String BundleId项
示例值:atret
BundleInfo String BundleInfo项
示例值:dsa
GeneralTaskParams Array of WorkflowGeneralTaskParam 通用参数

UpdateTriggerWorkflowResult

更新工作流结果

被如下接口引用:UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially。

名称 类型 描述
Status Boolean 更新工作流结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

UpdateWorkflowResult

更新工作流结果

被如下接口引用:UpdateWorkflow。

名称 类型 描述
Status Boolean 更新工作流结果
示例值:true

WorkflowDetail

查询工作流详细信息

被如下接口引用:GetWorkflow。

名称 类型 描述
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:hour_to_一次性
OwnerUin String 责任人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100029705957
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100029705957
WorkflowType String 工作流类型,cycle和manual
注意:此字段可能返回 null,表示取不到有效值。
示例值:cycle
WorkflowParams Array of ParamInfo 工作流参数数组
注意:此字段可能返回 null,表示取不到有效值。
WorkflowSchedulerConfiguration WorkflowSchedulerConfiguration 统一调度参数
注意:此字段可能返回 null,表示取不到有效值。
WorkflowDesc String 工作流描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述信息
Path String 工作流所属路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/keyl_p0_test/hour_to_一次性
BundleId String BundleId项
注意:此字段可能返回 null,表示取不到有效值。
示例值:be4b6673-96da-4402-beae-a89dbc4d627b
BundleInfo String BundleInfo项
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"aaa":"bbb"}

WorkflowFolder

文件夹信息

被如下接口引用:ListWorkflowFolders。

名称 类型 描述
ProjectId String 项目ID
FolderId String 文件夹ID
FolderPath String 文件夹绝对路径
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。

WorkflowFolderDetail

文件夹详细信息

被如下接口引用:GetWorkflowFolder。

名称 类型 描述
ProjectId String 项目ID
示例值:1460947878944567296
FolderId String 文件夹ID
示例值:c214c7d4-f617-11ee-8ec8-b8599f277de5
FolderPath String 文件夹绝对路径
示例值:/a/b
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100029386028
ParentFolderPath String 父文件夹绝对路径
示例值:/a
FolderName String 文件夹名称
示例值:b

WorkflowFolderPage

资源文件分页

被如下接口引用:ListWorkflowFolders。

名称 类型 描述
PageNumber Integer 数据页数,大于等于1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页显示的数据条数,最小为10条,最大为200 条
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalCount Integer 文件夹总数
示例值:5
TotalPageNumber Integer 总页数
示例值:2
Items Array of WorkflowFolder 文件夹列表

WorkflowGeneralTaskParam

工作流SPARK_SQL参数

被如下接口引用:CreateTriggerWorkflow, GetTriggerWorkflow, UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially。

名称 类型 必选 描述
Type String 通用任务参数类型,目前只支持SPARK_SQL
注意:此字段可能返回 null,表示取不到有效值。
示例值:SPARK_SQL
Value String 通用任务参数内容, 不同参数用;
分割
注意:此字段可能返回 null,表示取不到有效值。
示例值:name

WorkflowInfo

获取工作流的列表信息item

被如下接口引用:ListWorkflows。

名称 类型 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:135
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:135
WorkflowType String 工作流类型,cycle及manual
注意:此字段可能返回 null,表示取不到有效值。
示例值:cycle
OwnerUin String 负责人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:135
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-09-22 17:03:05
ModifyTime String 最新修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-09-25 17:03:05
UpdateUserUin String 最后更新人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:135
WorkflowDesc String 工作流描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:v1
CreateUserUin String 创建人ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:135

WorkflowMaxPermission

用户对工作流文件夹的递归最大权限类型

被如下接口引用:GetMyWorkflowMaxPermission。

名称 类型 描述
PermissionType String 授权权限类型(CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE,当前仅支持CAN_MANAGE)
注意:此字段可能返回 null,表示取不到有效值。

WorkflowPermission

数据开发授权信息

被如下接口引用:CreateWorkflowPermissions, ListWorkflowPermissions。

名称 类型 必选 描述
PermissionTargetType String 授权目标类型(用户:user,角色:role)
注意:此字段可能返回 null,表示取不到有效值。
示例值:user
PermissionTargetId String 授权目标id数组(userId/roleId)
注意:此字段可能返回 null,表示取不到有效值。
示例值:100028578851
PermissionTypeList Array of String 授权权限类型数组(CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE,当前仅支持CAN_MANAGE)
注意:此字段可能返回 null,表示取不到有效值。
示例值:["CAN_MANAGE"]

WorkflowPermissionPage

数据开发分页的权限信息

被如下接口引用:ListWorkflowPermissions。

名称 类型 描述
PageNumber Integer 数据页数,大于等于1
PageSize Integer 每页显示的数据条数,最小为10条,最大为200 条
TotalCount Integer 授权数据总数
TotalPageNumber Integer 总页数
Items Array of WorkflowPermission 授权信息列表

WorkflowSchedulerConfiguration

工作流统一调度出参

被如下接口引用:GetWorkflow。

名称 类型 描述
ScheduleTimeZone String 时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:UTC+8
CycleType String 周期类型:支持的类型为
ONEOFF_CYCLE: 一次性
YEAR_CYCLE: 年
MONTH_CYCLE: 月
WEEK_CYCLE: 周
DAY_CYCLE: 天
HOUR_CYCLE: 小时
MINUTE_CYCLE: 分钟
CRONTAB_CYCLE: crontab表达式类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:HOUR_CYCLE
SelfDepend String 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序)
注意:此字段可能返回 null,表示取不到有效值。
示例值:serial
StartTime String 生效开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-09-11 00:00:00
EndTime String 生效结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2099-12-31 23:59:59
DependencyWorkflow String 工作流依赖,yes or no
注意:此字段可能返回 null,表示取不到有效值。
示例值:no
ExecutionStartTime String 执行时间左闭区间,示例:00:00
注意:此字段可能返回 null,表示取不到有效值。
示例值:00:00
ExecutionEndTime String 执行时间右闭区间,示例:23:59
注意:此字段可能返回 null,表示取不到有效值。
示例值:23:59
CrontabExpression String cron表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:0 0 0 * * ?
CalendarOpen String 是否开启日历调度 1 开启 0关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CalendarName String 日历名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:交易所日历
CalendarId String 日历id
注意:此字段可能返回 null,表示取不到有效值。
示例值:105

WorkflowSchedulerConfigurationInfo

工作流统一调度参数入参
依赖任务信息

取值说明表:

当前任务周期类型 上游任务周期类型 配置方式 MainCyclicConfig取值 时间维度/实例范围 SubordinateCyclicConfig取值 offset取值
HOUR_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
MINUTE_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
DAY_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
DAY_CYCLE WEEK_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
HOUR_CYCLE HOUR_CYCLE 推荐策略 HOUR 按小时/最近实例 CURRENT_HOUR
HOUR_CYCLE HOUR_CYCLE 推荐策略 HOUR 按小时/前一周期 PREVIOUS_HOUR_CYCLE
HOUR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/上周 PREVIOUS_WEEK
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/上周五 PREVIOUS_FRIDAY
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/上周日 PREVIOUS_WEEKEND
WEEK_CYCLE DAY_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
WEEK_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 、 CURRENT_DAY
WEEK_CYCLE DAY_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
WEEK_CYCLE ONEOFF_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
HOUR_CYCLE MINUTE_CYCLE 推荐策略 HOUR 按小时/前一个小时(-60,0] PREVIOUS_HOUR_LATER_OFFSET_MINUTE
HOUR_CYCLE MINUTE_CYCLE 推荐策略 HOUR 按小时/前一个小时 PREVIOUS_HOUR
HOUR_CYCLE MINUTE_CYCLE 推荐策略 HOUR 按小时/当前小时 CURRENT_HOUR
YEAR_CYCLE WEEK_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
WEEK_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
MINUTE_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
WEEK_CYCLE HOUR_CYCLE 推荐策略 WEEK 按周/上周 PREVIOUS_WEEK
WEEK_CYCLE HOUR_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
MINUTE_CYCLE HOUR_CYCLE 推荐策略 HOUR 按小时/当前小时 CURRENT_HOUR
HOUR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE HOUR_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE HOUR_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE ONEOFF_CYCLE 推荐策略 MONTH 按月/当月 CURRENT_MONTH
DAY_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
DAY_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
MONTH_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
ONEOFF_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
MINUTE_CYCLE MINUTE_CYCLE 推荐策略 MINUTE 按分钟/当前分钟 CURRENT_MINUTE
MINUTE_CYCLE MINUTE_CYCLE 推荐策略 MINUTE 按分钟/前一周期 PREVIOUS_MINUTE_CYCLE
YEAR_CYCLE MINUTE_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
ONEOFF_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
DAY_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/前一天(-24 * 60,0] PREVIOUS_DAY_LATER_OFFSET_MINUTE
DAY_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
DAY_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
MINUTE_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
WEEK_CYCLE WEEK_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE YEAR_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
YEAR_CYCLE HOUR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
MINUTE_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
ONEOFF_CYCLE MINUTE_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
HOUR_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE MINUTE_CYCLE 推荐策略 WEEK 按周/上周 PREVIOUS_WEEK
WEEK_CYCLE MINUTE_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
DAY_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/前一天(-24,0] PREVIOUS_DAY_LATER_OFFSET_HOUR
DAY_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/前一天[-24,0) PREVIOUS_DAY
DAY_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
YEAR_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本年所有月 ALL_MONTH_OF_YEAR
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/上月末 PREVIOUS_END_OF_MONTH
YEAR_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/上月初 PREVIOUS_BEGIN_OF_MONTH
ONEOFF_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
DAY_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
ONEOFF_CYCLE HOUR_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
DAY_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
MINUTE_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
WEEK_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
WEEK_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
YEAR_CYCLE ONEOFF_CYCLE 推荐策略 YEAR 按年/当年 CURRENT_YEAR
MONTH_CYCLE DAY_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE DAY_CYCLE 推荐策略 MONTH 按月/上月末 PREVIOUS_END_OF_MONTH
MONTH_CYCLE DAY_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
MONTH_CYCLE DAY_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
YEAR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/本年所有天 ALL_DAY_OF_YEAR
YEAR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
YEAR_CYCLE DAY_CYCLE 推荐策略 DAY 按天/前一天 PREVIOUS_DAY
HOUR_CYCLE WEEK_CYCLE 推荐策略 WEEK 按周/本周 CURRENT_WEEK
MONTH_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/当月 CURRENT_MONTH
MONTH_CYCLE MONTH_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
MONTH_CYCLE MINUTE_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE MINUTE_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE WEEK_CYCLE 推荐策略 MONTH 按月/上月 PREVIOUS_MONTH
MONTH_CYCLE WEEK_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
MONTH_CYCLE WEEK_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
DAY_CYCLE YEAR_CYCLE 推荐策略 YEAR 按年/本年 CURRENT_YEAR
DAY_CYCLE YEAR_CYCLE 推荐策略 DAY 按天/最近一次数据时间的实例 RECENT_DATE
ONEOFF_CYCLE ONEOFF_CYCLE 推荐策略 DAY 按天/当天 CURRENT_DAY
ONEOFF_CYCLE MONTH_CYCLE 推荐策略 MONTH 按月/本月 CURRENT_MONTH
CRONTAB_CYCLE CRONTAB_CYCLE 推荐策略 CRONTAB CURRENT
HOUR_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
HOUR_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
WEEK_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
HOUR_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
WEEK_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
MONTH_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
YEAR_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
MINUTE_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
WEEK_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE HOUR_CYCLE 自定义 RANGE_HOUR 区间(小时) 逗号分隔的整数,如-1,0
DAY_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE DAY_CYCLE 自定义 RANGE_DAY 区间(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE MINUTE_CYCLE 自定义 RANGE_MINUTE 区间(分钟) 逗号分隔的整数,如-1,0
HOUR_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
HOUR_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
WEEK_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
HOUR_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
WEEK_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
MONTH_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
MINUTE_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
YEAR_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
MINUTE_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
WEEK_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0
DAY_CYCLE HOUR_CYCLE 自定义 LIST_HOUR 列表(小时) 逗号分隔的整数,如-1,0
DAY_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
YEAR_CYCLE DAY_CYCLE 自定义 LIST_DAY 列表(天) 逗号分隔的整数,如-1,0
MONTH_CYCLE MINUTE_CYCLE 自定义 LIST_MINUTE 列表(分钟) 逗号分隔的整数,如-1,0

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

名称 类型 必选 描述
ScheduleTimeZone String 时区
示例值:UTC+8
CycleType String 周期类型:支持的类型为
ONEOFF_CYCLE: 一次性
YEAR_CYCLE: 年
MONTH_CYCLE: 月
WEEK_CYCLE: 周
DAY_CYCLE: 天
HOUR_CYCLE: 小时
MINUTE_CYCLE: 分钟
CRONTAB_CYCLE: crontab表达式类型
示例值:HOUR_CYCLE
SelfDepend String 自依赖, 默认值 serial, 取值为:parallel(并行), serial(串行), orderly(有序)
示例值:serial
StartTime String 生效开始时间
示例值:2025-09-04 16:00:17
EndTime String 生效结束时间
示例值:2099-12-31 23:59:59
CrontabExpression String cron表达式
示例值:0 0 0 * * ?
DependencyWorkflow String 工作流依赖,yes or no
示例值:no
ModifyCycleValue String 0:不修改 1:将任务的上游依赖配置改为默认值
示例值:1
ClearLink Boolean 工作流存在跨工作流依赖且使用cron表达式调度。如果保存统一调度,会断开不支持的依赖关系
示例值:true
MainCyclicConfig String ModifyCycleValue为1的时候生效,表示默认修改的上游依赖-时间维度,取值为:
* CRONTAB
* DAY
* HOUR
* LIST_DAY
* LIST_HOUR
* LIST_MINUTE
* MINUTE
* MONTH
* RANGE_DAY
* RANGE_HOUR
* RANGE_MINUTE
* WEEK
* YEAR

https://capi.woa.com/object/detail?product=wedata&env=api_dev&version=2025-08-06&name=WorkflowSchedulerConfigurationInfo
示例值:HOUR
SubordinateCyclicConfig String ModifyCycleValue为1的时候生效,表示默认修改的上游依赖-实例范围
取值为:
* ALL_DAY_OF_YEAR
* ALL_MONTH_OF_YEAR
* CURRENT
* CURRENT_DAY
* CURRENT_HOUR
* CURRENT_MINUTE
* CURRENT_MONTH
* CURRENT_WEEK
* CURRENT_YEAR
* PREVIOUS_BEGIN_OF_MONTH
* PREVIOUS_DAY
* PREVIOUS_DAY_LATER_OFFSET_HOUR
* PREVIOUS_DAY_LATER_OFFSET_MINUTE
* PREVIOUS_END_OF_MONTH
* PREVIOUS_FRIDAY
* PREVIOUS_HOUR
* PREVIOUS_HOUR_CYCLE
* PREVIOUS_HOUR_LATER_OFFSET_MINUTE
* PREVIOUS_MINUTE_CYCLE
* PREVIOUS_MONTH
* PREVIOUS_WEEK
* PREVIOUS_WEEKEND
* RECENT_DATE

https://capi.woa.com/object/detail?product=wedata&env=api_dev&version=2025-08-06&name=WorkflowSchedulerConfigurationInfo
示例值:CURRENT_HOUR
ExecutionStartTime String 执行时间左闭区间,示例:00:00,只有周期类型为MINUTE_CYCLE才需要填入
示例值:00:00
ExecutionEndTime String 执行时间右闭区间,示例:23:59,只有周期类型为MINUTE_CYCLE才需要填入
示例值:23:59
CalendarOpen String 是否开启日历调度 1 开启 0关闭
示例值:1
CalendarId String 日历id
示例值:105

WorkflowTriggerConfig

工作流调度配置

被如下接口引用:CreateTriggerWorkflow, GetTriggerWorkflow, ListOpsTriggerWorkflows, UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially。

名称 类型 必选 描述
TriggerMode String 触发方式,
- 定时触发:TIME_TRIGGER
- 持续运行:CONTINUE_RUN
- 文件到达:FILE_ARRIVAL

注意:
- TIME_TRIGGER 和 CONTINUE_RUN 模式下,SchedulerStatus、SchedulerTimeZone、StartTime、EndTime、ConfigMode、CycleType、CrontabExpression 必填;
- FILE_ARRIVAL 模式下,FileArrivalPath、TriggerMinimumIntervalSecond、TriggerWaitTimeSecond 必填;
注意:此字段可能返回 null,表示取不到有效值。
示例值:CONTINUE_RUN
ExtraInfo String WorkflowTriggerConfig转换成Json格式,对账使用
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"TriggerId":"","SchedulerStatus":"ACTIVE","TriggerMode":"TIME_TRIGGER","SchedulerTimeZone":"Asia/Shanghai","StartTime":1759715744330,"EndTime":1762307744330,"ConfigMode":"COMMON","CycleType":"DAY_CYCLE","CrontabExpression":"0 4 19 * * ? *","ExtraInfo":""}
ScheduleTimeZone String 调度时区
注意:此字段可能返回 null,表示取不到有效值。
示例值:UTC+8
StartTime String 调度生效时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 17:27:58
EndTime String 调度结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-08-27 17:27:58
ConfigMode String 配置方式,常规:COMMON,CRON表达式:CRON_EXPRESSION
注意:此字段可能返回 null,表示取不到有效值。
示例值:CRON_EXPRESSION
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 4 19 * * ? *
TriggerId String triggerId, uuid
注意:此字段可能返回 null,表示取不到有效值。
示例值:a63aef9a-f37b-11ef-8d13-a4ae120f8272
FileArrivalPath String 文件到达模式下 存储系统中的监听路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:data/
TriggerMinimumIntervalSecond Integer 文件到达模式下 触发最短间隔时间(单位:秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:9600
TriggerWaitTimeSecond Integer 文件到达模式下 触发等待时间(单位:秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:9600
SchedulerStatus String Trigger 状态 启动ACTIVE,暂停PAUSED
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE