Data Types

Last updated:2026-03-13 12:14:17

Data Types

Last updated: 2026-03-13 12:14:17

AlarmGroup

Alarm rule recipient configuration.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
AlarmEscalationRecipientIds	Array of String	No	Specifies the list of Alarm escalation recipient ids. If the Alarm recipient or supervisor does not confirm the Alarm within the Alarm interval, an Alarm will be sent to the next-level superior.
AlarmEscalationInterval	Integer	No	Escalation interval for alarms.
NotificationFatigue	NotificationFatigue	No	Alarm notification fatigue configuration.
AlarmWays	Array of String	No	Alarm channel. valid values: 1. mail, 2. sms, 3. wechat, 4. voice, 5. wecom, 6. Http, 7. wecom group, 8. lark group, 9. dingtalk group, 10. Slack group, 11. Teams group (default: 1. mail). only select one channel.
WebHooks	Array of AlarmWayWebHook	No	webhook url list for wecom group/lark group/dingtalk group/Slack group/Teams group.
AlarmRecipientType	Integer	No	Alarm recipient type: 1. specified personnel, 2. task owner, 3. duty schedule (default: 1. specified personnel).
AlarmRecipientIds	Array of String	No	Specifies different business ids based on AlarmRecipientType. valid values: 1 (designated personnel): Alarm recipient id list. 2 (task owner): no configuration required. 3 (duty schedule): schedule id list.

AlarmMessage

Alarm information.

Used by actions: GetAlarmMessage, ListAlarmMessages.

Name	Type	Description
AlarmMessageId	Integer	Alarm message Id.
AlarmTime	String	Alarm time. the same Alarm may be sent multiple times, only the latest Alarm time is displayed.
TaskName	String	Task name.
TaskId	String	Task ID
CurRunDate	String	Instance data time of the task.
AlarmReason	String	Indicates the Alarm cause.
AlarmLevel	Integer	Alarm level. 1. ordinary, 2. important, 3. critical.
AlarmRuleId	String	Specifies the Id of the Alarm rule.
AlarmWays	Array of String	Alarm channel specifies the notification methods: 1. mail, 2. sms, 3. wechat, 4. voice, 5. wecom, 6. Http, 7. wecom group, 8. lark group, 9. dingtalk group, 10. Slack group, 11. Teams group (default: 1. mail).
AlarmRecipients	Array of String	Alarm recipient

AlarmQuietInterval

Alarm do-not-disturb time interval.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
DaysOfWeek	Array of Integer	No	ISO standard. 1 means monday, 7 means sunday.
StartTime	String	No	Start time. precision: hour/minute/second. format: HH:mm:ss.
EndTime	String	No	End time. precision: hour/minute/second. format: HH:mm:ss.

AlarmRuleData

Alarm Rule Details

Used by actions: GetOpsAlarmRule, ListOpsAlarmRules.

Name	Type	Description
AlarmRuleId	String	Alarm Rule ID
AlarmRuleName	String	Specifies the Alarm rule name.
Description	String	Describes the Alarm rule.
MonitorObjectType	Integer	Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm
MonitorObjectIds	Array of String	Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs. 2 (Workflow): MonitorObjectIds should contain a list of workflow IDs (workflow IDs can be obtained using the ListWorkflows API). 3 (Project): MonitorObjectIds should contain a list of project IDs.
AlarmTypes	Array of String	Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
Status	Integer	Whether the Alarm rule is enabled. Valid values: 0 (disabled), 1 (enabled).
AlarmRuleDetail	AlarmRuleDetail	Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.
AlarmLevel	Integer	Alarm level. 1. ordinary, 2. important, 3. critical.
OwnerUin	String	Specifies the id of the Alarm rule creator.
BundleId	String	The Alarm rule bound to the bundle client. it is normal if empty, otherwise it corresponds to the rule bound to the bundle client.
BundleInfo	String	bundleId is not empty. it indicates the bound client name.
AlarmGroups	Array of AlarmGroup	Describes the Alarm recipient configuration list.

AlarmRuleDetail

Detailed configuration of the Alarm rule.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
Trigger	Integer	No	Failure Trigger Condition 1: Trigger on the first failure 2: Trigger after all retries are completed (default)
DataBackfillOrRerunTrigger	Integer	No	Backfill/Rerun Trigger Condition 1: Trigger on the first failure 2: Trigger after all retries are completed
TimeOutExtInfo	Array of TimeOutStrategyInfo	No	Timeout configuration of the periodic instance.
DataBackfillOrRerunTimeOutExtInfo	Array of TimeOutStrategyInfo	No	Specifies the timeout configuration details for rerunning a backfill instance.
ProjectInstanceStatisticsAlarmInfoList	Array of ProjectInstanceStatisticsAlarmInfo	No	Specifies the detail of Alarm configuration for project fluctuation.
ReconciliationExtInfo	Array of ReconciliationStrategyInfo	No	Describes the Alarm configuration information for offline integration reconciliation.
MonitorWhiteTasks	Array of MonitorWhiteTask	No	Configure allowlist for monitored object.
WorkflowCompletionTimeCycleExtInfo	Array of TimeOutStrategyInfo	No	3.0 Workflow completion time (period) Alarm policy. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowExecutionTrigger	Integer	No	Workflow execution triggers the Alarm condition. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowExecutionFailureTrigger	Integer	No	Workflow execution failure Alarm condition. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowExecutionSuccessTrigger	Integer	No	Workflow execution successful Alarm condition. Note: This field may return null, indicating that no valid values can be obtained.

AlarmWayWebHook

Alarm channel specifies the webhook url configuration for wecom group, dingtalk group, or lark group.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
AlarmWay	String	No	Specifies the Alarm channel value. 7. wecom group 8. lark group 9. dingtalk group 10. Slack group 11. Teams group.
WebHooks	Array of String	No	webhook url list of the Alarm group.

AuthInfo

Permission user project information.

Used by actions: DescribeDataSourceAuthority.

Name	Type	Description
AuthProjectIds	Array of String	Authorize the target project id. Note: This field may return null, indicating that no valid values can be obtained.
AuthUsers	Array of String	List of users under the authorized project. Note: This field may return null, indicating that no valid values can be obtained.

AuthorizePrivilegesRsp

openapi authorization response.

Used by actions: AuthorizePrivileges.

Name	Type	Description
OverallSuccess	Boolean	Batch authorization result.
Results	Array of AuthorizeResult	Authorization details list.

AuthorizeResult

Authorization result.

Used by actions: AuthorizePrivileges, RevokePrivileges.

Name	Type	Required	Description
Resource	PrivilegeResource	No	Authorized resources. Note: This field may return null, indicating that no valid values can be obtained.
Result	Boolean	No	Result Note: This field may return null, indicating that no valid values can be obtained.
Reason	String	No	Reason. Note: This field may return null, indicating that no valid values can be obtained.

BackfillInstance

Description of a supplementary instance.

Used by actions: ListDataBackfillInstances.

Name	Type	Description
TaskName	String	Task name.
TaskId	String	Task ID
CurRunDate	String	Specifies the instance data time.
State	String	Execution status.
StartTime	String	Start time.
EndTime	String	End time.
CostTime	String	Execution duration.

BackfillInstanceCollection

Replenishment plan all instances.

Used by actions: ListDataBackfillInstances.

Name	Type	Description
PageNumber	Integer	Page number
PageSize	Integer	Pagination size.
TotalPageNumber	Integer	Total pages
TotalCount	Integer	Total number of records
Items	Array of BackfillInstance	Specifies the backfill instance list.

BatchOperationOpsDto

Batch operation result return.

Used by actions: UpdateOpsTriggerTasksOwner.

Name	Type	Description
SuccessCount	Integer	Number of batch operations succeeded.
FailedCount	Integer	Number of batch operations failed.
TotalCount	Integer	Total number of batch operations.
AsyncActionId	String	Unique id of the async operation record.

BindProject

Associate and bind a project.

Used by actions: ListResourceGroups.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
ProjectName	String	Project name. Note: This field may return null, indicating that no valid values can be obtained.
ProjectDisplayName	String	Project Display Name Note: This field may return null, indicating that no valid values can be obtained.

BizStateEnumInfoBrief

Workflow execution business enumeration info.

Used by actions: GetTriggerWorkflowRun.

Name	Type	Description
LabelKey	String	Tag key. Note: This field may return null, indicating that no valid values can be obtained.
LabelValue	String	Tag value Note: This field may return null, indicating that no valid values can be obtained.
Count	Integer	Total number of tags. Note: This field may return null, indicating that no valid values can be obtained.

BriefTask

Display task id and task name info.

Used by actions: GetDataSourceRelatedTasks.

Name	Type	Description
TaskId	String	Task ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskName	String	Task name. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Task creation time Note: This field may return null, indicating that no valid values can be obtained.
OwnerUinList	Array of String	Task owner id. a task may have multiple responsible persons. Note: This field may return null, indicating that no valid values can be obtained.

BusinessMetadata

Used by actions: GetTable, ListTable.

Name	Type	Required	Description
TagNames	Array of String	No	Tag name. Note: This field may return null, indicating that no valid values can be obtained.

CatalogInfo

Directory information.

Used by actions: ListCatalog.

Name	Type	Required	Description
Name	String	No	Directory name.

ChildDependencyConfigPage

Task downstream dependency details pagination.

Used by actions: ListDownstreamOpsTasks.

Name	Type	Description
TotalCount	Integer	Total number of results
TotalPageNumber	Integer	Total pages
PageNumber	Integer	Page number.
PageSize	Integer	Pagination size.
Items	Array of OpsTaskDepend	Paging data

CodeFile

Explore data script business processing entity.

Used by actions: CreateCodeFile, GetCodeFile, UpdateCodeFile.

Name	Type	Description
CodeFileId	String	Script ID
CodeFileName	String	Script name.
OwnerUin	String	Specifies the script owner uin.
CodeFileConfig	CodeFileConfig	Specifies the script configuration.
CodeFileContent	String	Specifies the script content.
UpdateUserUin	String	Latest operator.
ProjectId	String	Project ID.
UpdateTime	String	Update time. format: yyyy-MM-dd hh:MM:ss. Note: This field may return null, indicating that no valid
CreateTime	String	Creation time. format: yyyy-MM-dd hh:MM:ss.
AccessScope	String	Access permission: SHARED, PRIVATE.
Path	String	Full path of the node, /aaa/bbb/ccc.ipynb, consists of the name of each node.
ParentFolderPath	String	Parent folder path. Note: This field may return null, indicating that no valid values can be obtained.

CodeFileConfig

Data exploration script configuration.

Used by actions: CreateCodeFile, GetCodeFile, UpdateCodeFile.

Name	Type	Required	Description
Params	String	No	Advanced running parameter variable replacement map-json String,String.
NotebookSessionInfo	NotebookSessionInfo	No	notebook kernel session information.

CodeFolderNode

Explores data script file tree node.

Used by actions: GetCodeFolder, ListCodeFolderContents.

Name	Type	Description
Id	String	Unique identifier
Title	String	Name
Type	String	folder type, script.
IsLeaf	Boolean	Whether it is a leaf node.
Params	String	Business parameters
AccessScope	String	Permission scope: SHARED, PRIVATE.
Path	String	Node path.
OwnerUin	String	Specifies the uin of the responsible person for the directory/file.
CreateUserUin	String	Creator
NodePermission	String	Specifies the permission of the current user for nodes.
Children	Array of CodeFolderNode	Sub-node list
ParentFolderPath	String	Parent folder path. Note: This field may return null, indicating that no valid values can be obtained.

CodePermissionsResultItem

File authorization result for data exploration.

Used by actions: CreateCodePermissions, DeleteCodePermissions.

Name	Type	Required	Description
Item	String	No	Resource ID Note: This field may return null, indicating that no valid values can be obtained.
Result	Boolean	No	Whether the operation is successful for the resource permission. Note: This field may return null, indicating that no valid values can be obtained.
Reason	String	No	Specify the reason for the failure in the case of creation failure. Note: This field may return null, indicating that no valid values can be obtained.

CodeStudioFileActionResult

CodeStudio file object operation result.

Used by actions: DeleteCodeFile.

Name	Type	Description
Status	Boolean	Indicates whether the operation is successful. valid values: true (successful), false (unsuccessful).
CodeFileId	String	Folder ID.

CodeStudioFolderActionResult

CodeStudio folder object operation result.

Used by actions: DeleteCodeFolder, UpdateCodeFolder.

Name	Type	Description
Status	Boolean	Indicates whether the operation is successful. valid values: true (successful), false (unsuccessful).
FolderId	String	Folder ID.

CodeStudioFolderResult

CodeStudio folder object operation result.

Used by actions: CreateCodeFolder.

Name	Type	Description
FolderId	String	Folder ID. Note: This field may return null, indicating that no valid values can be obtained.

CodeStudioMaxPermission

Maximum permission scope for user to recurse files/folders in CodeStudio.

Used by actions: GetMyCodeMaxPermission.

Name	Type	Description
PermissionType	String	Authorization permission type (CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE). Note: This field may return null, indicating that no valid values can be obtained.

ColumnInfo

Used by actions: GetTableColumns.

Name	Type	Required	Description
Type	String	No	Field type Note: This field may return null, indicating that no valid values can be obtained.
Name	String	No	Field name
Length	Integer	No	Field length. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	No	Field description. Note: This field may return null, indicating that no valid values can be obtained.
Position	Integer	No	Field order. Note: This field may return null, indicating that no valid values can be obtained.
IsPartition	Boolean	No	Is partition field. Note: This field may return null, indicating that no valid values can be obtained.

CreateAlarmRuleData

Describes the response result of creating an Alarm rule.

Used by actions: CreateOpsAlarmRule.

Name	Type	Description
AlarmRuleId	String	Specifies the unique id of the Alarm rule.

CreateDataReplenishmentPlan

Creates a data backfill plan result.

Used by actions: CreateDataBackfillPlan.

Name	Type	Description
DataBackfillPlanId	String	Specifies the backfill plan Id.

CreateFolderResult

Folder creation result.

Used by actions: CreateResourceFolder, CreateWorkflowFolder.

Name	Type	Description
FolderId	String	Folder ID upon successful creation. error will be reported if creation failed.

CreateProjectResult

Create project result info.

Used by actions: CreateProject.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.

CreateResourceFileResult

Create resource file result.

Used by actions: CreateResourceFile.

Name	Type	Description
ResourceId	String	Resource file ID.

CreateTaskBaseAttribute

Describes the basic attribute information of the task.

Used by actions: CreateTask.

Name	Type	Required	Description
TaskName	String	Yes	Task name.
TaskTypeId	String	Yes	Task type 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
WorkflowId	String	Yes	Workflow ID.
OwnerUin	String	No	Task owner ID. defaults to the current user.
TaskDescription	String	No	Task description
TaskFolderPath	String	No	Task folder path. Note:. -Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" classification, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. -If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for the operation to succeed.

CreateTaskConfiguration

Creates task configuration information.

Used by actions: CreateTask.

Name	Type	Required	Description
ResourceGroup	String	No	Resource Group ID: Must be obtained via DescribeNormalSchedulerExecutorGroups API to get the ExecutorGroupId.
CodeContent	String	No	Base64 encoding of the code content.
TaskExtConfigurationList	Array of TaskExtParameter	No	Specifies the configuration list of task extended attributes.
DataCluster	String	No	Cluster ID
BrokerIp	String	No	Specifies the running node.
YarnQueue	String	No	Resource Pool Queue Name: Must be obtained using DescribeProjectClusterQueues API.
SourceServiceId	String	No	Source Data Source ID - One or more IDs separated by semicolons (;). Retrieve IDs using the DescribeDataSourceWithoutInfo API.
TargetServiceId	String	No	Target data source ID- One or more IDs separated by semicolons (;). Retrieve IDs using the DescribeDataSourceWithoutInfo API.
TaskSchedulingParameterList	Array of TaskSchedulingParameter	No	Scheduling parameter.
BundleId	String	No	ID used by the Bundle.
BundleInfo	String	No	Bundle info.

CreateTaskFolderResult

Create task folder result.

Used by actions: CreateTaskFolder.

Name	Type	Description
TaskFolderId	String	Folder ID of successful creation. if failed to create, error will be reported.

CreateTaskResult

Create task return format.

Used by actions: CreateTask, CreateTriggerTask.

Name	Type	Description
TaskId	String	Task ID

CreateTaskSchedulerConfiguration

Creates task scheduling configuration info.

Used by actions: CreateTask.

Name	Type	Required	Description
CycleType	String	No	Period type: defaults to DAY_CYCLE. Supported types. ONEOFF_CYCLE: specifies a one-time cycle. YEAR_CYCLE: specifies the year cycle. MONTH_CYCLE: specifies the monthly cycle. WEEK_CYCLE: specifies the week cycle. DAY_CYCLE: specifies the day cycle. HOUR_CYCLE: specifies the hour cycle. MINUTE_CYCLE: specifies the minute cycle. CRONTAB_CYCLE: specifies the crontab expression type.
ScheduleTimeZone	String	No	Time zone, defaults to UTC+8.
CrontabExpression	String	No	Cron expression, defaults to 0 0 0 * * ? *.
StartTime	String	No	Effective date, defaults to 00:00:00 of the current date.
EndTime	String	No	End date, defaults to 2099-12-31 23:59:59.
ExecutionStartTime	String	No	Execution time: the left-closed interval. Default: 00:00.
ExecutionEndTime	String	No	Execution time: the right closed interval. Default: 23:59.
CalendarOpen	String	No	Calendar scheduling value: 0 or 1, where 1 means ON and 0 means OFF. Default is 0.
CalendarId	String	No	Calendar scheduling: the calendar ID.
SelfDepend	String	No	Self-Dependent. Valid values: parallel, serial, orderly. Default value: serial.
UpstreamDependencyConfigList	Array of DependencyTaskBrief	No	Specifies the upstream dependency list.
EventListenerList	Array of EventListener	No	List of Events
AllowRedoType	String	No	Rerun & Refill Configuration: Default: ALL; * ALL: Rerun or refill is allowed regardless of whether the task succeeds or fails. * FAILURE: Rerun or refill is allowed only if the task fails; not allowed if the task succeeds. * NONE: Rerun or refill is not allowed regardless of success or failure.
ParamTaskOutList	Array of OutTaskParameter	No	Output parameter list.
ParamTaskInList	Array of InTaskParameter	No	Input parameter list.
TaskOutputRegistryList	Array of TaskDataRegistry	No	Output registration.
InitStrategy	String	No	Instance generation policy. T_PLUS_0: specifies t+0 generation. default policy. T_PLUS_1: specifies t+1 generation.
ScheduleType	Integer	No	Scheduling type: 0 normal scheduling 1 dry-run scheduling, defaults to 0.
RunPriorityType	Integer	No	Task scheduling priority. execution priority. valid values: 4 (high), 5 (medium), 6 (low). default: 6.
RetryWaitMinute	Integer	No	Retry policy retry wait time, in minutes: default: 5.
MaxRetryNumber	Integer	No	Maximum attempts of the retry policy. default: 4.
ExecutionTTLMinute	Integer	No	Timeout handling strategy runtime timeout (unit: minutes) defaults to -1.
WaitExecutionTotalTTLMinute	Integer	No	Timeout handling strategy wait duration timeout (unit: minutes) defaults to -1.

CreateTriggerTaskBaseAttribute

Create task basic attribute information.

Used by actions: CreateTriggerTask.

Name	Type	Required	Description
TaskName	String	Yes	Task name.
TaskTypeId	String	Yes	Task type 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
WorkflowId	String	Yes	Workflow ID.
OwnerUin	String	No	Task owner ID, defaults to the current user.
TaskDescription	String	No	Task description
TaskFolderPath	String	No	Task folder path. Note:. -Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" category, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. -If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for the operation to succeed.

CreateTriggerTaskConfiguration

Create task configuration.

Used by actions: CreateTriggerTask.

Name	Type	Required	Description
ResourceGroup	String	No	Resource group ID: need to pass through DescribeNormalSchedulerExecutorGroups to obtain ExecutorGroupId.
CodeContent	String	No	Base64 encoding of the code content.
TaskExtConfigurationList	Array of TaskExtParameter	No	Task extended attribute configuration list.
DataCluster	String	No	Cluster ID
BrokerIp	String	No	Specified running node.
YarnQueue	String	No	Resource pool queue name. need to pass through DescribeProjectClusterQueues to obtain.
SourceServiceId	String	No	Source data source ID, separated by semicolons, need to pass through DescribeDataSourceWithoutInfo to obtain.
TargetServiceId	String	No	Target data source ID, use ; to separate, need to pass through DescribeDataSourceWithoutInfo to obtain.
TaskSchedulingParameterList	Array of TaskSchedulingParameter	No	Scheduling parameter.
BundleId	String	No	ID used by the Bundle.
BundleInfo	String	No	Bundle info.

CreateTriggerTaskSchedulerConfiguration

Create task scheduling configuration info.

Used by actions: CreateTriggerTask.

Name	Type	Required	Description
UpstreamDependencyConfigList	Array of DependencyTriggerTaskBrief	No	Task array of upstream dependency.
RunPriorityType	Integer	No	Task scheduling priority. execution priority: 4 (high), 5 (medium), 6 (low). default: 6.
RetryWaitMinute	Integer	No	Retry policy retry wait time, in minutes: default: 5.
MaxRetryNumber	Integer	No	Retry policy maximum attempts. default: 4.
ExecutionTTLMinute	Integer	No	Timeout handling strategy runtime timeout (unit: minutes) defaults to -1.
WaitExecutionTotalTTLMinute	Integer	No	Timeout handling strategy wait duration timeout (unit: minutes) defaults to -1.
AllowRedoType	String	No	Rerun & replenishment configuration, defaults to ALL. ALL allows rerun or replenishment after successful or failed running. FAILURE does not allow rerun or replenishment after successful running, but allows rerun or replenishment after failed running. NONE does not allow rerun or replenishment after successful or failed running.
ParamTaskOutList	Array of OutTaskParameter	No	Output parameter array.
ParamTaskInList	Array of InTaskParameter	No	Input parameter array.
TaskOutputRegistryList	Array of TaskDataRegistry	No	Output registration.

CreateTriggerWorkflowResult

Create workflow result.

Used by actions: CreateTriggerWorkflow.

Name	Type	Description
WorkflowId	String	Workflow id after successful creation. Note: This field may return null, indicating that no valid values can be obtained.

CreateTriggerWorkflowRunResult

Workflow trigger execution result in workflow scheduling mode.

Used by actions: CreateTriggerWorkflowRun.

Name	Type	Description
WorkflowExecutionId	String	Workflow execution id. Note: This field may return null, indicating that no valid values can be obtained.

CreateWorkflowPermissionsResult

Workflow authorization result.

Used by actions: CreateWorkflowPermissions.

Name	Type	Description
Status	Boolean	Authorization result, true/false.

CreateWorkflowResult

Create workflow result.

Used by actions: CreateWorkflow.

Name	Type	Description
WorkflowId	String	Workflow id after successful creation.

DLCClusterInfo

dlc cluster information.

Used by actions: AddCalcEnginesToProject, CreateProject.

Name	Type	Required	Description
ComputeResources	Array of String	Yes	dlc resource name (the role Uin needs to be added to dlc, otherwise the resource may be unavailable). Note: This field may return null, indicating that no valid values can be obtained.
Region	String	Yes	dlc region. Note: This field may return null, indicating that no valid values can be obtained.
DefaultDatabase	String	Yes	Specify the default database for the DLC cluster. Note: This field may return null, indicating that no valid values can be obtained.
StandardModeEnvTag	String	No	Cluster configuration tag (only applicable to projects in standard mode and required in standard mode). valid values:. -Prod (live production environment). -Dev (development environment).
AccessAccount	String	No	Access account (only applicable to projects in standard mode and required in standard mode), used for submitting dlc tasks. Use a designated sub-account and set permissions to the corresponding database and table for the sub-account. task owner mode is prone to cause task failure after the person in charge leaves. master account mode is not easy to control permissions when permissions across multiple projects are different. Enumeration value:. -TASK_RUNNER (task owner). -OWNER (master account mode). -SUB (sub-account mode).
SubAccountUin	String	No	Sub-Account id (only applicable to projects in standard mode). when AccessAccount is in sub-account mode, the designated sub-account id information is required. other modes do not require specifying.

DataBackfill

Plan details.

Used by actions: GetDataBackfillPlan.

Name	Type	Description
ProjectId	String	Project ID.
DataBackfillPlanId	String	Data supplement plan id.
DataBackfillPlanName	String	Data supplement plan name.
TaskIds	Array of String	Supplementary task collection.
DataBackfillRangeList	Array of DataBackfillRange	Backfill task data configuration list.
CheckParentType	String	Check parent task type. valid values: NONE (do not check ALL), ALL (check ALL upstream parent tasks), MAKE_SCOPE (check only in the selected tasks of the present replenishment plan). Note: This field may return null, indicating that no valid values can be obtained.
SkipEventListening	Boolean	Specifies whether to ignore event dependency during backfill. Note: This field may return null, indicating that no valid values can be obtained.
RedefineParallelNum	Integer	Custom instance run degree of concurrency. return null or do not return indicates task original self-dependent. Note: This field may return null, indicating that no valid values can be obtained.
RedefineSelfWorkflowDependency	String	Custom workflow self-dependency, yes or no. if not configured, use the existing workflow self-dependency. Note: This field may return null, indicating that no valid values can be obtained.
SchedulerResourceGroupId	String	Scheduling resource group id. Note: This field may return null, indicating that no valid values can be obtained.
IntegrationResourceGroupId	String	Integration resource group id. Note: This field may return null, indicating that no valid values can be obtained.
RedefineCycleType	String	Backfill custom generation cycle. Note: This field may return null, indicating that no valid values can be obtained.
RedefineParamList	Array of KVPair	Custom parameter. Note: This field may return null, indicating that no valid values can be obtained.
StartTime	String	Execution start time of the backfill task. Note: This field may return null, indicating that no valid values can be obtained.
EndTime	String	Backfill task execution end time. Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Create a user id.
CompletePercent	Integer	Percentage of supplementary plan instances completed.
SuccessPercent	Integer	Percentage of supplementary plan instances successful.
DataTimeOrder	String	Backfill follows the instance data time sequence and must meet two conditions to take effect: 1. must be tasks in the same cycle 2. execute based on dependencies, or execute based on configured execution ORDER without dependency impact available values: - NORMAL: leave unset - ORDER: sequence - REVERSE: descending ORDER if not set, the default is NORMAL. Note: This field may return null, indicating that no valid values can be obtained.

DataBackfillRange

Backfill plan date range.

Used by actions: CreateDataBackfillPlan, GetDataBackfillPlan.

Name	Type	Required	Description
StartDate	String	No	Start date in yyyy-MM-dd format. indicates the start from 00:00:00 on the specified date.
EndDate	String	No	End date in the format yyyy-MM-dd, indicates ending at 23:59:59 of the specified date.
ExecutionStartTime	String	No	Start time of each day between [StartDate, EndDate] in HH:mm format. effective for tasks with a period of hours or less.
ExecutionEndTime	String	No	End time point between [StartDate, EndDate] in HH:mm format. effective for tasks with a period of hours or less.

DataSource

Data source object.

Used by actions: GetDataSource, ListDataSources.

Name	Type	Description
ProjectId	String	Belonging project ID. Note: This field may return null, indicating that no valid values can be obtained.
Id	Integer	Data source ID. Note: This field may return null, indicating that no valid values can be obtained.
Type	String	Data source type: enumeration value. Note: This field may return null, indicating that no valid values can be obtained.
Name	String	Data source name Note: This field may return null, indicating that no valid values can be obtained.
DisplayName	String	Data source display name for visual inspection. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Data source description information Note: This field may return null, indicating that no valid values can be obtained.
ProjectName	String	Affiliated project Name. Note: This field may return null, indicating that no valid values can be obtained.
CreateUser	String	Data source creator. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Time Note: This field may return null, indicating that no valid values can be obtained.
ModifyUser	String	Updater Note: This field may return null, indicating that no valid values can be obtained.
ModifyTime	String	Update time Note: This field may return null, indicating that no valid values can be obtained.
ProdConProperties	String	Configuration message of data sources is stored in JSON KV. KV storage information varies based on data source type. Note: This field may return null, indicating that no valid values can be obtained.
DevConProperties	String	Same as params content for developing data of data sources. Note: This field may return null, indicating that no valid values can be obtained.
Category	String	Data source type. -DB - custom definition source. -CLUSTER --- system source. Note: This field may return null, indicating that no valid values can be obtained.

DataSourceFileUpload

Upload data source file.

Used by actions: CreateDataSource, UpdateDataSource.

Name	Type	Required	Description
TrustStore	String	No	Truststore authentication file, default filename truststore.jks.
KeyStore	String	No	Keystore authentication file, default filename keystore.jks.
CoreSite	String	No	core-site.xml file.
HdfsSite	String	No	hdfs-site.xml file.
HiveSite	String	No	hive-site.xml file.
HBASESite	String	No	hbase-site file.
KeyTab	String	No	Keytab file, default filename [data source name].keytab.
KRB5Conf	String	No	krb5.conf file.
PrivateKey	String	No	Private key, default filename private_key.pem.
PublicKey	String	No	Public key, default filename public_key.pem.

DataSourceInfo

Query data source pagination list.

Used by actions: ListDataSources.

Name	Type	Description
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Pagination size. Note: This field may return null, indicating that no valid values can be obtained.
Items	Array of DataSource	Data Source List Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total score page number. Note: This field may return null, indicating that no valid values can be obtained.

DataSourceResult

Operation result of the data source.

Used by actions: CreateDataSource.

Name	Type	Description
Status	Boolean	Whether the operation is successful Note: This field may return null, indicating that no valid values can be obtained.
DataSourceId	Integer	Data source ID. Note: This field may return null, indicating that no valid values can be obtained.

DataSourceStatus

Operation result of the data source.

Used by actions: AuthorizeDataSource, DeleteDataSource, RevokeDataSourceAuthorization, UpdateDataSource.

Name	Type	Description
Status	Boolean	Data source operation status. Note: This field may return null, indicating that no valid values can be obtained.

DatabaseInfo

Database information

Used by actions: ListDatabase.

Name	Type	Required	Description
Guid	String	No	Database GUID. Note: This field may return null, indicating that no valid values can be obtained.
Name	String	No	Database name. Note: This field may return null, indicating that no valid values can be obtained.
CatalogName	String	No	Database catalog. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	No	Repository description. Note: This field may return null, indicating that no valid values can be obtained.
Location	String	No	Database location. Note: This field may return null, indicating that no valid values can be obtained.
StorageSize	Integer	No	Database storage size. Note: This field may return null, indicating that no valid values can be obtained.
DatasourceId	Integer	No	Data source ID. Note: This field may return null, indicating that no valid values can be obtained.
DatasourceType	String	No	Data source type. Note: This field may return null, indicating that no valid values can be obtained.

DatasourceRelationTaskInfo

Task info of data source association.

Used by actions: GetDataSourceRelatedTasks.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
ProjectName	String	Project name. Note: This field may return null, indicating that no valid values can be obtained.
TaskInfo	Array of RelateTask	Data source association task info. the current period only supports data development task API return data. Note: This field may return null, indicating that no valid values can be obtained.

DeleteAlarmRuleResult

Describes the response result of deleting an Alarm rule.

Used by actions: DeleteOpsAlarmRule.

Name	Type	Description
Status	Boolean	Whether deletion succeeded.

DeleteFolderResult

Delete resource folder result.

Used by actions: DeleteResourceFolder, DeleteWorkflowFolder.

Name	Type	Description
Status	Boolean	Deletion status. true indicates success, false indicates failure.

DeleteResourceFileResult

Delete resource file result.

Used by actions: DeleteResourceFile.

Name	Type	Description
Status	Boolean	true

DeleteTaskFolderResult

Delete resource folder result.

Used by actions: DeleteTaskFolder.

Name	Type	Description
Status	Boolean	Deletion status. true: successful, false: unsuccessful.

DeleteTaskResult

Deletion result of a data development task.

Used by actions: DeleteTask, DeleteTriggerTask.

Name	Type	Description
Status	Boolean	Deletion status. true indicates success. false indicates failure.

DeleteTriggerWorkflowResult

Delete workflow result.

Used by actions: DeleteTriggerWorkflow.

Name	Type	Description
Status	Boolean	Whether deleting the workflow is successful. Note: This field may return null, indicating that no valid values can be obtained.

DeleteWorkflowPermission

Data development authorization information to delete.

Used by actions: DeleteWorkflowPermissions.

Name	Type	Required	Description
PermissionTargetType	String	Yes	Target type to delete (user: user, role: role, group: group).
PermissionTargetId	String	Yes	Authorization target id (userId/roleId) to delete.
PermissionTypeList	Array of String	Yes	Type array of authorization permissions to delete (CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE, currently only support CAN_MANAGE).

DeleteWorkflowPermissionsResult

Deletion result of development permissions.

Used by actions: DeleteWorkflowPermissions.

Name	Type	Description
Status	Boolean	Delete result true/false.

DeleteWorkflowResult

Delete workflow result.

Used by actions: DeleteWorkflow.

Name	Type	Description
Status	Boolean	Indicates whether the workflow deletion was successful

DependencyConfigPage

Paginated Query of Upstream Task Dependency Details

Used by actions: ListDownstreamTasks, ListUpstreamTasks.

Name	Type	Description
TotalCount	Integer	Total number of records matching the query conditions.
TotalPageNumber	Integer	Total number of pages matching the query conditions.
PageNumber	Integer	The page number of the current request.
PageSize	Integer	The number of entries in the current request data page.
Items	Array of TaskDependDto	Paginated Data

DependencyStrategyTask

Dependency configuration policy.

Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially.

Name	Type	Required	Description
PollingNullStrategy	String	No	Wait upstream task instance policy: EXECUTING (execute); WAITING (wait).
TaskDependencyExecutingStrategies	Array of String	No	This field is required only when PollingNullStrategy is set to EXECUTING. Type: List NOT_EXIST (default) - In cases where minute depends on minute / hour depends on hour, the parent instance does not fall within the scheduling time range of the downstream instance. PARENT_EXPIRED - The parent instance failed. PARENT_TIMEOUT - The parent instance timed out. If any of the above conditions are met, the dependency check for that parent task instance is considered satisfied. In all other cases, the system must wait for the parent instance.
TaskDependencyExecutingTimeoutValue	Integer	No	This field is required only when TaskDependencyExecutingStrategies includes PARENT_TIMEOUT. Specifies the timeout duration (in minutes) for the downstream task's dependency on the parent instance execution.

DependencyTaskBrief

Dependency Task Information - Value Reference Table:

Value description table:
| Current Task Cycle Type | Upstream Task Cycle Type | Configuration Mode | MainCyclicConfig Value | Time Dimension / Instance Scope | SubordinateCyclicConfig Value | offset Value |
| ----------------------- | ------------------------ | ------------------ | ---------------------- | -------------------------------------- | --------------------------------- | ------------------------------------ |
| HOUR_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| MINUTE_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| DAY_CYCLE | WEEK_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| DAY_CYCLE | WEEK_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| HOUR_CYCLE | HOUR_CYCLE | Recommended Policy | HOUR | By Hour / Latest Instance | CURRENT_HOUR | None |
| HOUR_CYCLE | HOUR_CYCLE | Recommended Policy | HOUR | By Hour / Previous Cycle | PREVIOUS_HOUR_CYCLE | None |
| HOUR_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| WEEK_CYCLE | DAY_CYCLE | Recommended Policy | WEEK | By Week / Previous Week | PREVIOUS_WEEK | None |
| WEEK_CYCLE | DAY_CYCLE | Recommended Policy | WEEK | By Week / Previous Friday | PREVIOUS_FRIDAY | None |
| WEEK_CYCLE | DAY_CYCLE | Recommended Policy | WEEK | By Week / Previous Sunday | PREVIOUS_WEEKEND | None |
| WEEK_CYCLE | DAY_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| WEEK_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| WEEK_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Previous Day | PREVIOUS_DAY | None |
| WEEK_CYCLE | ONEOFF_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| HOUR_CYCLE | MINUTE_CYCLE | Recommended Policy | HOUR | By Hour / Previous Hour (-60,0] | PREVIOUS_HOUR_LATER_OFFSET_MINUTE | None |
| HOUR_CYCLE | MINUTE_CYCLE | Recommended Policy | HOUR | By Hour / Previous Hour | PREVIOUS_HOUR | None |
| HOUR_CYCLE | MINUTE_CYCLE | Recommended Policy | HOUR | By Hour / Current Hour | CURRENT_HOUR | None |
| YEAR_CYCLE | WEEK_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| WEEK_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| MINUTE_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| WEEK_CYCLE | HOUR_CYCLE | Recommended Policy | WEEK | By Week / Previous Week | PREVIOUS_WEEK | None |
| WEEK_CYCLE | HOUR_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| MINUTE_CYCLE | HOUR_CYCLE | Recommended Policy | HOUR | By Hour / Current Hour | CURRENT_HOUR | None |
| HOUR_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| MONTH_CYCLE | HOUR_CYCLE | Recommended Policy | MONTH | By Month / Previous Month | PREVIOUS_MONTH | None |
| MONTH_CYCLE | HOUR_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| MONTH_CYCLE | ONEOFF_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| DAY_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| DAY_CYCLE | MONTH_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| MONTH_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| ONEOFF_CYCLE | WEEK_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| MINUTE_CYCLE | MINUTE_CYCLE | Recommended Policy | MINUTE | By Minute / Current Minute | CURRENT_MINUTE | None |
| MINUTE_CYCLE | MINUTE_CYCLE | Recommended Policy | MINUTE | By Minute / Previous Cycle | PREVIOUS_MINUTE_CYCLE | None |
| YEAR_CYCLE | MINUTE_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| ONEOFF_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| DAY_CYCLE | MINUTE_CYCLE | Recommended Policy | DAY | By Day / Previous Day (-24 * 60,0] | PREVIOUS_DAY_LATER_OFFSET_MINUTE | None |
| DAY_CYCLE | MINUTE_CYCLE | Recommended Policy | DAY | By Day / Previous Day | PREVIOUS_DAY | None |
| DAY_CYCLE | MINUTE_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| MINUTE_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| WEEK_CYCLE | WEEK_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| WEEK_CYCLE | WEEK_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| YEAR_CYCLE | YEAR_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| YEAR_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| YEAR_CYCLE | HOUR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| MINUTE_CYCLE | WEEK_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| ONEOFF_CYCLE | MINUTE_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| HOUR_CYCLE | ONEOFF_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| WEEK_CYCLE | MINUTE_CYCLE | Recommended Policy | WEEK | By Week / Previous Week | PREVIOUS_WEEK | None |
| WEEK_CYCLE | MINUTE_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| DAY_CYCLE | HOUR_CYCLE | Recommended Policy | DAY | By Day / Previous Day (-24,0] | PREVIOUS_DAY_LATER_OFFSET_HOUR | None |
| DAY_CYCLE | HOUR_CYCLE | Recommended Policy | DAY | By Day / Previous Day [-24,0) | PREVIOUS_DAY | None |
| DAY_CYCLE | HOUR_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| YEAR_CYCLE | MONTH_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| YEAR_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / All Months of Current Year | ALL_MONTH_OF_YEAR | None |
| YEAR_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| YEAR_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Previous Month | PREVIOUS_MONTH | None |
| YEAR_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / End of Previous Month | PREVIOUS_END_OF_MONTH | None |
| YEAR_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Beginning of Previous Month | PREVIOUS_BEGIN_OF_MONTH | None |
| ONEOFF_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| DAY_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| ONEOFF_CYCLE | HOUR_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| DAY_CYCLE | ONEOFF_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| MINUTE_CYCLE | ONEOFF_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| WEEK_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| WEEK_CYCLE | MONTH_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| YEAR_CYCLE | ONEOFF_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| MONTH_CYCLE | DAY_CYCLE | Recommended Policy | MONTH | By Month / Previous Month | PREVIOUS_MONTH | None |
| MONTH_CYCLE | DAY_CYCLE | Recommended Policy | MONTH | By Month / End of Previous Month | PREVIOUS_END_OF_MONTH | None |
| MONTH_CYCLE | DAY_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| MONTH_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| MONTH_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Previous Day | PREVIOUS_DAY | None |
| YEAR_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / All Days of Current Year | ALL_DAY_OF_YEAR | None |
| YEAR_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| YEAR_CYCLE | DAY_CYCLE | Recommended Policy | DAY | By Day / Previous Day | PREVIOUS_DAY | None |
| HOUR_CYCLE | WEEK_CYCLE | Recommended Policy | WEEK | By Week / Current Week | CURRENT_WEEK | None |
| MONTH_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| MONTH_CYCLE | MONTH_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| MONTH_CYCLE | MINUTE_CYCLE | Recommended Policy | MONTH | By Month / Previous Month | PREVIOUS_MONTH | None |
| MONTH_CYCLE | MINUTE_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| MONTH_CYCLE | WEEK_CYCLE | Recommended Policy | MONTH | By Month / Previous Month | PREVIOUS_MONTH | None |
| MONTH_CYCLE | WEEK_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| MONTH_CYCLE | WEEK_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| DAY_CYCLE | YEAR_CYCLE | Recommended Policy | YEAR | By Year / Current Year | CURRENT_YEAR | None |
| DAY_CYCLE | YEAR_CYCLE | Recommended Policy | DAY | By Day / Instance of Latest Data Time | RECENT_DATE | None |
| ONEOFF_CYCLE | ONEOFF_CYCLE | Recommended Policy | DAY | By Day / Current Day | CURRENT_DAY | None |
| ONEOFF_CYCLE | MONTH_CYCLE | Recommended Policy | MONTH | By Month / Current Month | CURRENT_MONTH | None |
| CRONTAB_CYCLE | CRONTAB_CYCLE | Recommended Policy | CRONTAB | None | CURRENT | None |
| HOUR_CYCLE | HOUR_CYCLE | Custom | RANGE_HOUR | Range (hours) | None | Comma-separated integers, e.g., -1,0 |
| HOUR_CYCLE | DAY_CYCLE | Custom | RANGE_DAY | Range (days) | None | Comma-separated integers, e.g., -1,0 |
| WEEK_CYCLE | DAY_CYCLE | Custom | RANGE_DAY | Range (days) | None | Comma-separated integers, e.g., -1,0 |
| HOUR_CYCLE | MINUTE_CYCLE | Custom | RANGE_MINUTE | Range (minutes) | None | Comma-separated integers, e.g., -1,0 |
| WEEK_CYCLE | HOUR_CYCLE | Custom | RANGE_HOUR | Range (hours) | None | Comma-separated integers, e.g., -1,0 |
| MINUTE_CYCLE | HOUR_CYCLE | Custom | RANGE_HOUR | Range (hours) | None | Comma-separated integers, e.g., -1,0 |
| MONTH_CYCLE | HOUR_CYCLE | Custom | RANGE_HOUR | Range (hours) | None | Comma-separated integers, e.g., -1,0 |
| MINUTE_CYCLE | MINUTE_CYCLE | Custom | RANGE_MINUTE | Range (minutes) | None | Comma-separated integers, e.g., -1,0 |
| YEAR_CYCLE | MINUTE_CYCLE | Custom | RANGE_MINUTE | Range (minutes) | None | Comma-separated integers, e.g., -1,0 |
| DAY_CYCLE | MINUTE_CYCLE | Custom | RANGE_MINUTE | Range (minutes) | None | Comma-separated integers, e.g., -1,0 |
| MINUTE_CYCLE | DAY_CYCLE | Custom | RANGE_DAY | Range (days) | None | Comma-separated integers, e.g., -1,0 |
| YEAR_CYCLE | HOUR_CYCLE | Custom | RANGE_HOUR | Range (hours) | None | Comma-separated integers, e.g., -1,0 |
| WEEK_CYCLE | MINUTE_CYCLE | Custom | RANGE_MINUTE | Range (minutes) | None | Comma-separated integers, e.g., -1,0 |
| DAY_CYCLE | HOUR_CYCLE | Custom | RANGE_HOUR | Range (hours) | None | Comma-separated integers, e.g., -1,0 |
| DAY_CYCLE | DAY_CYCLE | Custom | RANGE_DAY | Range (days) | None | Comma-separated integers, e.g., -1,0 |
| MONTH_CYCLE | DAY_CYCLE | Custom | RANGE_DAY | Range (days) | None | Comma-separated integers, e.g., -1,0 |
| YEAR_CYCLE | DAY_CYCLE | Custom | RANGE_DAY | Range (days) | None | Comma-separated integers, e.g., -1,0 |
| MONTH_CYCLE | MINUTE_CYCLE | Custom | RANGE_MINUTE | Range (minutes) | None | Comma-separated integers, e.g., -1,0 |
| HOUR_CYCLE | HOUR_CYCLE | Custom | LIST_HOUR | List (hours) | None | Comma-separated integers, e.g., -1,0 |
| HOUR_CYCLE | DAY_CYCLE | Custom | LIST_DAY | List (days) | None | Comma-separated integers, e.g., -1,0 |
| WEEK_CYCLE | DAY_CYCLE | Custom | LIST_DAY | List (days) | None | Comma-separated integers, e.g., -1,0 |
| HOUR_CYCLE | MINUTE_CYCLE | Custom | LIST_MINUTE | List (minutes) | None | Comma-separated integers, e.g., -1,0 |
| WEEK_CYCLE | HOUR_CYCLE | Custom | LIST_HOUR | List (hours) | None | Comma-separated integers, e.g., -1,0 |
| MINUTE_CYCLE | HOUR_CYCLE | Custom | LIST_HOUR | List (hours) | None | Comma-separated integers, e.g., -1,0 |
| MONTH_CYCLE | HOUR_CYCLE | Custom | LIST_HOUR | List (hours) | None | Comma-separated integers, e.g., -1,0 |
| MINUTE_CYCLE | MINUTE_CYCLE | Custom | LIST_MINUTE | List (minutes) | None | Comma-separated integers, e.g., -1,0 |
| YEAR_CYCLE | MINUTE_CYCLE | Custom | LIST_MINUTE | List (minutes) | None | Comma-separated integers, e.g., -1,0 |
| DAY_CYCLE | MINUTE_CYCLE | Custom | LIST_MINUTE | List (minutes) | None | Comma-separated integers, e.g., -1,0 |
| MINUTE_CYCLE | DAY_CYCLE | Custom | LIST_DAY | List (days) | None | Comma-separated integers, e.g., -1,0 |
| YEAR_CYCLE | HOUR_CYCLE | Custom | LIST_HOUR | List (hours) | None | Comma-separated integers, e.g., -1,0 |
| WEEK_CYCLE | MINUTE_CYCLE | Custom | LIST_MINUTE | List (minutes) | None | Comma-separated integers, e.g., -1,0 |
| DAY_CYCLE | HOUR_CYCLE | Custom | LIST_HOUR | List (hours) | None | Comma-separated integers, e.g., -1,0 |
| DAY_CYCLE | DAY_CYCLE | Custom | LIST_DAY | List (days) | None | Comma-separated integers, e.g., -1,0 |
| MONTH_CYCLE | DAY_CYCLE | Custom | LIST_DAY | List (days) | None | Comma-separated integers, e.g., -1,0 |
| YEAR_CYCLE | DAY_CYCLE | Custom | LIST_DAY | List (days) | None | Comma-separated integers, e.g., -1,0 |
| MONTH_CYCLE | MINUTE_CYCLE | Custom | LIST_MINUTE | List (minutes) | None | Comma-separated integers, e.g., -1,0 |

Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially.

Name	Type	Required	Description
TaskId	String	Yes	Task ID
MainCyclicConfig	String	Yes	Main dependency configuration. Valid values: * CRONTAB * DAY * HOUR * LIST_DAY * LIST_HOUR * LIST_MINUTE * MINUTE * MONTH * RANGE_DAY * RANGE_HOUR * RANGE_MINUTE * WEEK * YEAR
SubordinateCyclicConfig	String	No	Configures secondary dependencies. Valid values: * 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
Offset	String	No	Offset in Range/List Mode
DependencyStrategy	DependencyStrategyTask	No	Dependency Execution Policy

DependencyTriggerTaskBrief

Dependent task info.

Used by actions: CreateTriggerTask, GetTriggerTask, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
TaskId	String	Yes	Task ID. Note: This field may return null, indicating that no valid values can be obtained.

EventListener

Event listener.

Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially.

Name	Type	Required	Description
EventName	String	Yes	Event name
EventSubType	String	Yes	Event cycle. valid values: SECOND, MIN, HOUR, DAY.
EventBroadcastType	String	Yes	Event BROADCAST type: SINGLE, BROADCAST.
PropertiesList	Array of ParamInfo	No	Extension Information

ExecutionActionBrief

Operation execution result.

Used by actions: KillTriggerWorkflowRuns.

Name	Type	Description
ItemId	String	Operate entity ID. Note: This field may return null, indicating that no valid values can be obtained.
ItemName	String	Operate the entity name. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionActionId	String	Operation ID. Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage	String	Failure information. Note: This field may return null, indicating that no valid values can be obtained.
OpStatus	Boolean	Operation status. true: successful, false: unsuccessful.

ExecutorResourceGroupData

ExecutorResourceGroup pagination object.

Used by actions: ListResourceGroups.

Name	Type	Description
Items	Array of ExecutorResourceGroupInfo	Result list. Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of entries Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Number of pages. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Page size. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Page number of total score. Note: This field may return null, indicating that no valid values can be obtained.

ExecutorResourceGroupInfo

Resource group details

Used by actions: ListResourceGroups.

Name	Type	Description
Id	String	Resource group unique id.
Name	String	Resource group name. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Resource group description Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupType	String	Execute the resource group type. values cannot be empty. -Schedule --- scheduling resource group. -Integration - integration resource group. -DataService - data service resource group. Note: This field may return null, indicating that no valid values can be obtained.
AssociateProjects	Array of BindProject	Project set. Note: This field may return null, indicating that no valid values can be obtained.
Region	String	Region. Note: This field may return null, indicating that no valid values can be obtained.
VpcId	String	vpcId Note: This field may return null, indicating that no valid values can be obtained.
SubNet	String	Subnet ID Note: This field may return null, indicating that no valid values can be obtained.
AutoRenewEnabled	Boolean	Whether to perform auto-renewal. Note: This field may return null, indicating that no valid values can be obtained.

ExploreAuthorizationObject

File authorization subject for data exploration.

Used by actions: CreateCodePermissions.

Name	Type	Required	Description
Resource	ExploreFileResource	No	Authorized resource info, including resourceId and resourceType. Note: This field may return null, indicating that no valid values can be obtained.
AuthorizeSubjects	Array of ExploreAuthorizeSubject	No	Authorization details. Note: This field may return null, indicating that no valid values can be obtained.

ExploreAuthorizationRecycleObject

Data exploration file recycling policy.

Used by actions: DeleteCodePermissions.

Name	Type	Required	Description
Resource	ExploreFileResource	No	File resource information. Note: This field may return null, indicating that no valid values can be obtained.
RecycleSubjects	Array of ExploreAuthorizeSubject	No	Authorization details. Note: This field may return null, indicating that no valid values can be obtained.

ExploreAuthorizeSubject

Data exploration file authorization principal.

Used by actions: CreateCodePermissions, DeleteCodePermissions.

Name	Type	Required	Description
SubjectType	String	No	Type (user, role, group). Note: This field may return null, indicating that no valid values can be obtained.
SubjectValues	Array of String	No	Value list. Note: This field may return null, indicating that no valid values can be obtained.
Privileges	Array of String	No	Permission list Note: This field may return null, indicating that no valid values can be obtained.

ExploreFilePermissionsPage

Data exploration file permission list page.

Used by actions: ListCodePermissions.

Name	Type	Description
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Pagination size. Note: This field may return null, indicating that no valid values can be obtained.
Rows	Array of ExploreFilePrivilegeItem	Permission list Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total score page number. Note: This field may return null, indicating that no valid values can be obtained.

ExploreFilePrivilegeItem

Explore file permission details.

Used by actions: ListCodePermissions.

Name	Type	Required	Description
Privileges	Array of String	No	Permission point. Note: This field may return null, indicating that no valid values can be obtained.
RoleType	String	No	User: user role: role group: group. Note: This field may return null, indicating that no valid values can be obtained.
RoleId	String	No	User or role ID. Note: This field may return null, indicating that no valid values can be obtained.
Resource	ExploreFileResource	No	Authorized resources. Note: This field may return null, indicating that no valid values can be obtained.
DeleteAble	Boolean	No	Whether can be deleted. Note: This field may return null, indicating that no valid values can be obtained.

ExploreFileResource

Data exploration file resources.

Used by actions: CreateCodePermissions, DeleteCodePermissions, ListCodePermissions.

Name	Type	Required	Description
ResourceType	String	No	Resource type, can only be two types: folder, script. Note: This field may return null, indicating that no valid values can be obtained.
ResourceId	String	No	Resource ID: directory ID or script ID. Note: This field may return null, indicating that no valid values can be obtained.
ResourceIdForPath	String	No	Full path id for recursive authentication. Note: This field may return null, indicating that no valid values can be obtained.
ResourceCFSPath	String	No	cfs path. Note: This field may return null, indicating that no valid values can be obtained.

Filter

Universal filter.

Used by actions: GetTriggerWorkflowRun, ListOpsTriggerWorkflows, ListQualityRuleTemplates, ListTriggerWorkflowRuns.

Name	Type	Required	Description
Name	String	No	Filter field name.
Values	Array of String	No	Filter value list.

GetResourcePrivilegeDetailRsp

Used by actions: ListPermissions.

Name	Type	Required	Description
Details	Array of ResourcePrivilegeDetail	No	List of permission details.
TotalCount	Integer	No	Total.

InTaskParameter

Parameter passing - reference parameter.

Used by actions: CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
ParamKey	String	Yes	Parameter name.
ParamDesc	String	Yes	Parameter Description: The format is ProjectIdentifier.TaskName.ParameterName Example: project_wedata_1.sh_250820_104107.pp_out
FromTaskId	String	Yes	Parent Task ID
FromParamKey	String	Yes	Parent task parameter key.

InstanceExecution

Describes the details of an instance.

Used by actions: ListTaskInstanceExecutions.

Name	Type	Description
InstanceKey	String	Instance unique identifier.
LifeRoundNum	Integer	Instance lifecycle number, identifies one-time execution of the instance.. For example, the first run of a periodic instance is numbered 0. if the user reruns the instance subsequently, the second execution is numbered 1.
InstanceState	String	Instance status. -WAIT_EVENT: specifies the wait for event. -WAIT_UPSTREAM: waiting for upstream. - WAIT_RUN: awaiting execution. - RUNNING: indicates the instance is RUNNING. - SKIP_RUNNING: SKIP RUNNING. - FAILED_RETRY: RETRY on failure. - EXPIRED: failed. -COMPLETED: success.
RunType	String	Trigger type for instance running. -RERUN indicates a rerun. -ADDITION indicates supplementary recording. -PERIODIC indicates a period. -APERIODIC indicates non-periodic. -RERUN_SKIP_RUN indicates rerun - empty run. -ADDITION_SKIP_RUN indicates a supplementary empty run. -PERIODIC_SKIP_RUN indicates cycle - empty run. -APERIODIC_SKIP_RUN indicates non-periodic empty run. -MANUAL_TRIGGER indicates manual triggering. -RERUN_MANUAL_TRIGGER indicates manual triggering - rerun.
Tries	Integer	Specifies the number of retry attempts on failure.
ExecutionPhaseList	Array of InstanceExecutionPhase	Specifies the lifecycle list for instance execution..
CostTime	Integer	Time spent, in milliseconds.

InstanceExecutionPhase

Describes the details of each stage in instance execution.

Used by actions: ListTaskInstanceExecutions.

Name	Type	Required	Description
StartTime	String	No	Start time of the state.
DetailState	String	No	Instance lifecycle phase status. -WAIT_UPSTREAM indicates the wait event/upstream status. -WAIT_RUN indicates the waiting for running status. -RUNNING indicates the running state. -COMPLETE indicates the final state of completion. - FAILED indicates the final state - retry on failure. -EXPIRED indicates the final state - failure. -SKIP_RUNNING indicates the branch skipped by the upstream branch node in the final state. -HISTORY indicates compatibility with historical instances before 2024-03-30. no need to pay attention to this enum afterward.
EndTime	String	No	End time of the state.

InstanceLog

Instance log content.

Used by actions: GetTaskInstanceLog.

Name	Type	Description
InstanceKey	String	Instance unique id.
ProjectId	String	Project ID.
CodeContent	String	Specifies the code content to run.
LogInfo	String	log information
NextCursor	String	Used for paginated log queries; has no specific business meaning. For the first query, set the value to null. For subsequent queries, use the NextCursor value returned from the previous query.

IntegrationResource

Integration resource group.

Used by actions: CreateResourceGroup.

Name	Type	Required	Description
RealTimeDataSync	ResourceGroupSpecification	No	Real-Time integration resource group. -i32c (real-time data sync - 16c64G).
OfflineDataSync	ResourceGroupSpecification	No	Offline integration resource group. -integrated (offline data sync-8C16G). -i16 (offline data sync-8C32G).

JobDto

Data exploration JOB.

Used by actions: ListSQLScriptRuns, RunSQLScript.

Name	Type	Required	Description
JobId	String	No	Task ID of the data exploration.
JobName	String	No	Task name.
JobType	String	No	Task type
ScriptId	String	No	Script ID
JobExecutionList	Array of JobExecutionDto	No	Subtask List
ScriptContent	String	No	Specifies the script content.
Status	String	No	State of a task.
CreateTime	String	No	Task creation time
UpdateTime	String	No	Update time.
EndTime	String	No	End time.
OwnerUin	String	No	Root account UIN.
UserUin	String	No	Account UIN.
TimeCost	Integer	No	Duration. specifies the time taken.
ScriptContentTruncate	Boolean	No	Specifies whether the script content is truncated.

JobExecutionDto

Describes the subtask of a business submission JOB.

Used by actions: ListSQLScriptRuns, RunSQLScript.

Name	Type	Required	Description
JobId	String	Yes	Job ID of the data exploration.
JobExecutionId	String	Yes	Query job ID.
JobExecutionName	String	Yes	Specifies the subquery name.
ScriptContent	String	Yes	Specifies the subquery sql content.
Status	String	Yes	Subquery status.
CreateTime	String	Yes	Creation time.
ExecuteStageInfo	String	No	Execution phase.
LogFilePath	String	No	Log path
ResultFilePath	String	No	Result path for download.
ResultPreviewFilePath	String	No	Preview result path.
ResultTotalCount	Integer	No	Total number of lines in the task execution result.
UpdateTime	String	No	Update time.
EndTime	String	No	End time.
TimeCost	Integer	No	Duration. specifies the time taken.
ContextScriptContent	Array of String	No	SQL content in the context.
ResultPreviewCount	Integer	No	Specifies the preview row count for task execution results.
ResultEffectCount	Integer	No	Specifies the number of affected rows in task execution.
CollectingTotalResult	Boolean	No	Whether the full result is being collected: default false. true indicates the full result is being collected, for the frontend to determine whether to continue to poll.
ScriptContentTruncate	Boolean	No	Specifies whether to truncate the script content.

KVMap

map

Used by actions: RerunTaskInstancesAsync.

Name	Type	Required	Description
K	String	No	k
V	String	No	v

KVPair

Key-value pair

Used by actions: CreateDataBackfillPlan, GetDataBackfillPlan.

Name	Type	Required	Description
K	String	No	Key name
V	String	No	The value. do not pass SQL (the request will be deemed as an attack on the api). if needed, transcode the SQL with Base64 and decode it.

LineageNodeInfo

LineageNodeInfo lineage relationship entity.

Used by actions: ListColumnLineage, ListLineage.

Name	Type	Description
Resource	LineageResource	Current resource. Note: This field may return null, indicating that no valid values can be obtained.
Relation	LineageRelation	Relationship. Note: This field may return null, indicating that no valid values can be obtained.
DownStreamCount	Integer	Upstream quantity.
UpStreamCount	Integer	Downstream quantity.

LineagePair

Lineage Pair object.

Used by actions: DeleteLineage, ListProcessLineage, RegisterLineage.

Name	Type	Required	Description
Source	LineageResouce	Yes	Source.
Target	LineageResouce	Yes	Goal.
Processes	Array of LineageProcess	Yes	Lineage processing process.

LineageProcess

LineageProcess lineage generation process.

Used by actions: DeleteLineage, ListColumnLineage, ListLineage, ListProcessLineage, RegisterLineage.

Name	Type	Required	Description
ProcessId	String	Yes	Original unique ID. Note: This field may return null, indicating that no valid values can be obtained.
ProcessType	String	Yes	Task type Schedule task execution. SCHEDULE_TASK, Integration task. INTEGRATION_TASK, Third-Party reporting. THIRD_REPORT, Data modeling. TABLE_MODEL, Create metrics for the model. MODEL_METRIC, Create a derived metric from atomic metrics. METRIC_METRIC, Data service. DATA_SERVICE Note: This field may return null, indicating that no valid values can be obtained.
Platform	String	Yes	WEDATA, THIRD; Note: This field may return null, indicating that no valid values can be obtained.
ProcessSubType	String	No	Task Subtype SQL_TASK, Integrate real-time tasks lineage. INTEGRATED_STREAM, Integration of offline tasks lineage. INTEGRATED_OFFLINE; Note: This field may return null, indicating that no valid values can be obtained.
ProcessProperties	Array of LineageProperty	No	Additional parameters. Note: This field may return null, indicating that no valid values can be obtained.
LineageNodeId	String	No	Unique node ID of the lineage task.

LineageProperty

LineageProperty additional parameters.

Used by actions: DeleteLineage, ListColumnLineage, ListLineage, ListProcessLineage, RegisterLineage.

Name	Type	Required	Description
Name	String	No	Attribute Name Note: This field may return null, indicating that no valid values can be obtained.
Value	String	No	Attribute value Note: This field may return null, indicating that no valid values can be obtained.

LineageRelation

Lineage relationship.

Used by actions: ListColumnLineage, ListLineage.

Name	Type	Description
RelationId	String	Association ID Note: This field may return null, indicating that no valid values can be obtained.
SourceUniqueId	String	Source lineage ID. Note: This field may return null, indicating that no valid values can be obtained.
TargetUniqueId	String	Target unique lineage ID. Note: This field may return null, indicating that no valid values can be obtained.
Processes	Array of LineageProcess	Lineage processing process. Note: This field may return null, indicating that no valid values can be obtained.

LineageResouce

Lineage resource entity.

Used by actions: DeleteLineage, ListProcessLineage, RegisterLineage.

Name	Type	Required	Description
ResourceUniqueId	String	Yes	Original unique ID of the entity. Remark: when the lineage is a table column, pass the table ResourceUniqueId::field name as the unique ID. Note: This field may return null, indicating that no valid values can be obtained.
ResourceType	String	Yes	Entity type. TABLE
Platform	String	Yes	Source: WEDATA
ResourceName	String	No	Service name: database name.table name
Description	String	No	Description: table type
CreateTime	String	No	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime	String	No	Update time Note: This field may return null, indicating that no valid values can be obtained.
ResourceProperties	Array of LineageProperty	No	resource additional parameters. Note: This field may return null, indicating that no valid values can be obtained.
LineageNodeId	String	No	Unique identifier symbol of the lineage node.

LineageResource

Lineage resource entity.

Used by actions: ListColumnLineage, ListLineage.

Name	Type	Required	Description
ResourceUniqueId	String	No	Original unique ID of the entity. Note: This field may return null, indicating that no valid values can be obtained.
ResourceName	String	No	Service name: database name.table name
ResourceType	String	No	Entity type. TABLE
LineageNodeId	String	No	Unique identifier of the node lineage symbol. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	No	Description: table type
Platform	String	No	Source: WEDATA
CreateTime	String	No	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime	String	No	Update time Note: This field may return null, indicating that no valid values can be obtained.
ResourceProperties	Array of LineageProperty	No	resource additional parameters. Note: This field may return null, indicating that no valid values can be obtained.

ListAlarmMessages

Alarm information list.

Used by actions: ListAlarmMessages.

Name	Type	Description
PageNumber	Integer	Page number.
PageSize	Integer	Pagination size.
TotalCount	Integer	Total number of entries
TotalPageNumber	Integer	Total pages
Items	Array of AlarmMessage	Alarm information list.

ListAlarmRulesResult

Query Alarm rule list.

Used by actions: ListOpsAlarmRules.

Name	Type	Description
PageNumber	Integer	Page number for pagination. current page number.
PageSize	Integer	Specifies the number of items to display per page.
TotalPageNumber	Integer	Total number of pages.
TotalCount	Integer	Count of all Alarm rules.
Items	Array of AlarmRuleData	Alert rule information list.

ListCatalogPage

Used by actions: ListCatalog.

Name	Type	Description
Items	Array of CatalogInfo	Directory record list.
PageCount	Integer	Total number of pages.
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number
TotalCount	Integer	Total number of records

ListDatabasePage

Used by actions: ListDatabase.

Name	Type	Description
Items	Array of DatabaseInfo	Database record list.
PageCount	Integer	Total number of pages.
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number
TotalCount	Integer	Total number of records

ListLineagePage

Used by actions: ListColumnLineage, ListLineage.

Name	Type	Description
Items	Array of LineageNodeInfo	Lineage record list.
PageCount	Integer	Total number of pages.
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number
TotalCount	Integer	Total number of records

ListOpsTasksPage

Task list pagination.

Used by actions: ListOpsTasks.

Name	Type	Description
TotalCount	Integer	Total number of results
TotalPageNumber	Integer	Total pages
Items	Array of TaskOpsInfo	Record list
PageNumber	Integer	Page number.
PageSize	Integer	Pagination size.

ListProcessLineagePage

ListLineagePage

Used by actions: ListProcessLineage.

Name	Type	Description
Items	Array of LineagePair	Lineage pair list.
PageCount	Integer	Total number of pages.
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number
TotalCount	Integer	Total number of records

ListSchemaPage

Used by actions: ListSchema.

Name	Type	Description
Items	Array of SchemaInfo	Schema record list.
PageCount	Integer	Total number of pages.
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number
TotalCount	Integer	Total number of records

ListTablePage

Used by actions: ListTable.

Name	Type	Description
Items	Array of TableInfo	Record list.
PageCount	Integer	Total number of pages.
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number
TotalCount	Integer	Total number of records

ListTaskInfo

Query Task Info (Paginated)

Used by actions: ListTasks.

Name	Type	Description
Items	Array of TaskBaseAttribute	Task Array
PageNumber	Integer	Current request data page number.
PageSize	Integer	Number of entries in the current request.
TotalCount	Integer	Total number of data entries that meet the query condition.
TotalPageNumber	Integer	Total number of pages that meet the query condition.

ListTaskVersions

Describes the pagination list of query task versions.

Used by actions: ListTaskVersions.

Name	Type	Description
Items	Array of TaskVersion	Record list
TotalCount	Integer	Total number of records that meet the query condition.
TotalPageNumber	Integer	Total number of pages that meet the query condition.
PageCount	Integer	Number of records on current page.
PageSize	Integer	Specifies the number of entries in the current request data page.
PageNumber	Integer	Specifies the data page number of the current request.

ListTriggerTaskInfo

Query task information pagination.

Used by actions: ListTriggerTasks.

Name	Type	Description
Items	Array of TriggerTaskBaseAttribute	Task Array Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Current request data page. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Number of entries in the current request data page. Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of data entries that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total number of pages that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.

ListTriggerTaskVersions

Query task version pagination list.

Used by actions: ListTriggerTaskVersions.

Name	Type	Description
Items	Array of TriggerTaskVersion	Record list Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of records that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total number of pages that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.
PageCount	Integer	Number of records on current page. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Number of entries in the current request data page. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Page number of the current request. Note: This field may return null, indicating that no valid values can be obtained.

ListTriggerWorkflowInfo

Query workflow pagination list.

Used by actions: ListTriggerWorkflows.

Name	Type	Description
Items	Array of TriggerWorkflowInfo	List item. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total number of pages that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Current request data page. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Number of entries in the current request data page. Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of data entries that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.

ListWorkflowInfo

Query workflow pagination list.

Used by actions: ListWorkflows.

Name	Type	Description
Items	Array of WorkflowInfo	List items.
TotalPageNumber	Integer	Total number of pages that meet the query condition.
PageNumber	Integer	Current request data page number.
PageSize	Integer	Number of entries in the current request.
TotalCount	Integer	Total number of data entries that meet the query condition.

MetricData

Monitoring metrics

Used by actions: GetResourceGroupMetrics.

Name	Type	Description
MetricName	String	Metric name -ConcurrencyUsage --- concurrency usage rate. -CpuCoreUsage --- cpu utilization. -CpuLoad --- cpu load. -DevelopQueueTask --- number of tasks in the queue. -Number of running develop tasks. -DevelopSchedulingTask --- number of development tasks being scheduled. -DiskUsage --- disk usage. -DiskUsed --- disk used amount. -MaximumConcurrency --- maximum concurrency. -MemoryLoad --- memory load. -MemoryUsage --- memory usage. Note: This field may return null, indicating that no valid values can be obtained.
SnapshotValue	Integer	Current value. Note: This field may return null, indicating that no valid values can be obtained.
TrendList	Array of TrendData	Metric trend. Note: This field may return null, indicating that no valid values can be obtained.

ModifyAlarmRuleResult

Describes the response of updating an Alarm rule.

Used by actions: UpdateOpsAlarmRule.

Name	Type	Description
Status	Boolean	Whether update succeeded

MonitorWhiteTask

Monitor allowlist configuration with Alarm rules.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
MonitorObjectId	String	No	Configure the allowlist corresponding to the workflow/project id.
TaskIds	Array of String	No	Allowlist task list.

NotebookSessionInfo

notebook kernel session information.

Used by actions: CreateCodeFile, UpdateCodeFile.

Name	Type	Required	Description
NotebookSessionId	String	No	Specifies the session ID.
NotebookSessionName	String	No	Session Name

NotificationFatigue

Alarm fatigue Alarm configuration.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
NotifyCount	Integer	No	Number of alarms.
NotifyInterval	Integer	No	Alarm interval, in minutes.
QuietIntervals	Array of AlarmQuietInterval	No	Do not disturb period, such as example value. [{DaysOfWeek: [1, 2], StartTime: "00:00:00", EndTime: "09:00:00"}] Specifies notification muting from 00:00 to 09:00 every monday and tuesday.

OperateResult

Used by actions: DeleteLineage, RegisterLineage.

Name	Type	Required	Description
Status	Integer	No	Operation result 1 success other failures.

OpsAsyncJobDetail

Asynchronous operation details.

Used by actions: GetOpsAsyncJob.

Name	Type	Required	Description
ProjectId	String	No	Project ID.
AsyncId	String	No	Operation ID
AsyncType	String	No	Asynchronous operation type.
Status	String	No	Asynchronous operation status: initial status: INIT; Running: RUNNING; Success: SUCCESS; failure: FAIL; partially successful: PART_SUCCESS.
ErrorDesc	String	No	Error message.
TotalSubProcessCount	Integer	No	Total sub-processes.
FinishedSubProcessCount	Integer	No	Number of completed sub-processes.
SuccessSubProcessCount	Integer	No	Count of successful sub-processes.
CreateUserUin	String	No	Operator id.
CreateTime	String	No	Creation time.
UpdateTime	String	No	Update time.

OpsAsyncResponse

Asynchronous operation return structure.

Used by actions: DeleteDataBackfillPlanAsync, KillTaskInstancesAsync, PauseOpsTasksAsync, RerunTaskInstancesAsync, RerunTriggerWorkflowRunAsync, SetSuccessTaskInstancesAsync, StopOpsTasksAsync.

Name	Type	Description
AsyncId	String	Asynchronous execution record Id.

OpsTaskDepend

Dependent task information.

Used by actions: ListDownstreamOpsTasks, ListUpstreamOpsTasks.

Name	Type	Description
TaskId	String	Task ID
TaskName	String	Task name.
WorkflowId	String	Workflow id.
WorkflowName	String	Workflow name.
ProjectId	String	Project ID.
ProjectName	String	Project name.
Status	String	Task Status -N: New -Y: Scheduling -F: Offline -O: Paused -T: Offlining -INVALID: Invalid
TaskTypeId	Integer	Task type 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 Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeDesc	String	Task type description. -20 : universal data synchronization. - 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: specifies the branch. -131: specifies the merge. -132: specifies the Notebook explore. -133: specifies the SSH node. - 134 : StarRocks - 137 : For-each -10000: common custom business. Note: This field may return null, indicating that no valid values can be obtained.
FolderName	String	Folder name.
FolderId	String	Folder ID
FirstSubmitTime	String	Latest submission time.
FirstRunTime	String	First running time
ScheduleDesc	String	Describes the scheduling plan display description information.
CycleType	String	Task Cycle Type * ONEOFF_CYCLE: One-time * YEAR_CYCLE: Yearly * MONTH_CYCLE: Monthly * WEEK_CYCLE: Weekly * DAY_CYCLE: Daily * HOUR_CYCLE: Hourly * MINUTE_CYCLE: Minute-level * CRONTAB_CYCLE: Crontab expression-based
OwnerUin	String	Specifies the person in charge.
ExecutionStartTime	String	Execution start time. format: HH:mm, for example 00:00.
ExecutionEndTime	String	Execution end time. format: HH:mm, for example 23:59.

OpsWorkflow

Workflow list pagination details.

Used by actions: ListOpsWorkflows.

Name	Type	Description
TaskCount	Integer	Number of Tasks
FolderName	String	folder name.
FolderId	String	Workflow folder id.
WorkflowId	String	Workflow id.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowType	String	Specifies the workflow type. -cycle period. -manual.
WorkflowDesc	String	Workflow description.
OwnerUin	String	Responsible user id, multiple ';' separators.
ProjectId	String	Project ID.
ProjectName	String	Project name.
Status	String	Workflow Status * ALL_RUNNING: All running (all workflows are in scheduling state) * ALL_FREEZED: All paused * ALL_STOPPTED: All stopped * PART_RUNNING: Partially running (some workflows are running, others not) * ALL_NO_RUNNING: All not scheduled * ALL_INVALID: All invalid
CreateTime	String	Workflow creation time.
UpdateTime	String	Latest update time. specifies development and production updates.
UpdateUserUin	String	Last updated by, including development and production updates.

OpsWorkflowDetail

Workflow scheduling details.

Used by actions: GetOpsWorkflow.

Name	Type	Description
WorkflowId	String	Workflow ID.
WorkflowDesc	String	Workflow description.
WorkflowType	String	Specifies the workflow type. -cycle. -manual.
CreateTime	String	Creation time.
CreateUserUin	String	Creator
UpdateTime	String	Modification time.
StartupTime	Integer	Delayed execution time. unit: minute.
StartTime	String	Effective date. specifies the start date.
EndTime	String	Configure end date end date.
CycleType	String	Task Cycle Type * ONEOFF_CYCLE: One-time * YEAR_CYCLE: Yearly * MONTH_CYCLE: Monthly * WEEK_CYCLE: Weekly * DAY_CYCLE: Daily * HOUR_CYCLE: Hourly * MINUTE_CYCLE: Minute-level * CRONTAB_CYCLE: Crontab expression-based
FolderId	String	Folder ID
InstanceInitStrategy	String	Task instance initialization strategy. -T_PLUS_1 (t+1): initializes with a one-day delay. -T_PLUS_0 (t+0): initialize on the day. -T_MINUS_1 (t-1): initialize one day in advance.
SchedulerDesc	String	Specifies the scheduling plan interpretation.
FirstSubmitTime	String	First submission time of workflow.
LatestSubmitTime	String	Latest submission time of workflow.
Status	String	Workflow Status * ALL_RUNNING: All running (all workflows are in scheduling state) * ALL_FREEZED: All paused * ALL_STOPPTED: All stopped * PART_RUNNING: Partially running (some workflows are running, others not) * ALL_NO_RUNNING: All not scheduled * ALL_INVALID: All invalid
OwnerUin	String	Person in charge. multiple values are separated by a ";" separator.
WorkflowName	String	Workflow name.

OpsWorkflows

Query workflow pagination list.

Used by actions: ListOpsWorkflows.

Name	Type	Description
Items	Array of OpsWorkflow	Record list
TotalCount	Integer	Total number of results
TotalPageNumber	Integer	Total pages
PageSize	Integer	Pagination size.
PageNumber	Integer	Page number

OrderField

Universal sort field.

Used by actions: GetTriggerWorkflowRun, ListOpsTriggerWorkflows, ListPermissions, ListQualityRuleTemplates, ListTriggerWorkflowRuns.

Name	Type	Required	Description
Name	String	Yes	Sort field name
Direction	String	Yes	Sorting order: ASC

OutTaskParameter

Parameter passing - output parameter.

Used by actions: CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
ParamKey	String	Yes	Parameter name.
ParamValue	String	Yes	Parameter definition.

Page

Page parameter.

Used by actions: ListPermissions.

Name	Type	Required	Description
PageSize	Integer	No	Page size. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	No	Page number Note: This field may return null, indicating that no valid values can be obtained.

PageRoles

Get role list pagination information.

Used by actions: ListProjectRoles.

Name	Type	Description
Items	Array of SystemRole	Role information. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Pagination size. Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total page number. Note: This field may return null, indicating that no valid values can be obtained.

ParamInfo

Parameters

Used by actions: CreateTask, CreateTriggerWorkflow, CreateWorkflow, GetOpsTask, GetTask, GetTriggerWorkflow, GetWorkflow, UpdateTask, UpdateTaskPartially, UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially, UpdateWorkflow.

Name	Type	Required	Description
ParamKey	String	Yes	Parameter name.
ParamValue	String	Yes	Parameter value.

ParentDependencyConfigPage

Query job upstream dependency details pagination.

Used by actions: ListUpstreamOpsTasks.

Name	Type	Description
TotalCount	Integer	Total number of results
TotalPageNumber	Integer	Total pages
PageNumber	Integer	Page number.
PageSize	Integer	Pagination size.
Items	Array of OpsTaskDepend	Paging data

PrivilegeInfo

Permission information

Used by actions: AuthorizePrivileges, ListPermissions, RevokePrivileges.

Name	Type	Required	Description
Name	String	No	Permission name. Note: This field may return null, indicating that no valid values can be obtained.
DisplayName	String	No	Display name of the permission. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	No	Permission description. Note: This field may return null, indicating that no valid values can be obtained.
IsRead	Boolean	No	Whether read permission. Note: This field may return null, indicating that no valid values can be obtained.
IsManage	Boolean	No	Whether it is a management permission. Note: This field may return null, indicating that no valid values can be obtained.
Granted	Boolean	No	Checks whether the permission is available. used when checking permissions. Note: This field may return null, indicating that no valid values can be obtained.
InheritedObject	PrivilegeResource	No	Specifies the resource it inherits from. used when querying permission details. Note: This field may return null, indicating that no valid values can be obtained.
Inherited	Boolean	No	Not inheritable, used when querying permission details. Note: This field may return null, indicating that no valid values can be obtained.
IsEdit	Boolean	No	Whether edit permission. Note: This field may return null, indicating that no valid values can be obtained.
IsMetaDataPermission	Boolean	No	Whether metadata permissions (displayed on the front-end).
CatalogID	String	No	CatalogID (deprecated). Note: This field may return null, indicating that no valid values can be obtained.
CatalogName	String	No	catalog name (deprecated). Note: This field may return null, indicating that no valid values can be obtained.
WorkSpaceID	String	No	Space ID (deprecated). Note: This field may return null, indicating that no valid values can be obtained.
WorkSpaceName	String	No	Space name (deprecated). Note: This field may return null, indicating that no valid values can be obtained.

PrivilegeResource

Permission resource model.

Used by actions: AuthorizePrivileges, ListPermissions, RevokePrivileges.

Name	Type	Required	Description
ResourceType	String	No	Resource type, Catalog, Schema. Note: This field may return null, indicating that no valid values can be obtained.
ResourceUri	String	No	Resource URI. Note: This field may return null, indicating that no valid values can be obtained.

Project

This API is used to obtain project information.

Used by actions: GetProject, ListProjects.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
ProjectName	String	Project id, english name. Note: This field may return null, indicating that no valid values can be obtained.
DisplayName	String	Project display name, can be chinese name. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Remarks Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	Timestamp ISO8601	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
CreatorUin	String	Project creator id. Note: This field may return null, indicating that no valid values can be obtained.
ProjectOwnerUin	String	Project responsible person id. Note: This field may return null, indicating that no valid values can be obtained.
Status	Integer	Project status: 0: disabled, 1: enabled, -3: disabled, 2: enabled.
ProjectModel	String	Project mode, SIMPLE: SIMPLE mode STANDARD: STANDARD mode. Note: This field may return null, indicating that no valid values can be obtained.

ProjectBrief

Query data source pagination list.

Used by actions: ListProjects.

Name	Type	Description
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Pagination size. Note: This field may return null, indicating that no valid values can be obtained.
Items	Array of Project	Data Source List Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total page number. Note: This field may return null, indicating that no valid values can be obtained.

ProjectInstanceStatisticsAlarmInfo

Alarm rule project fluctuation rate Alarm configuration information.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
AlarmType	String	Yes	Alarm type projectFailureInstanceUpwardFluctuationAlarm: specifies the upward fluctuation alert for failed instances. projectSuccessInstanceDownwardFluctuationAlarm: specifies the downward fluctuation alert for successful instances.
InstanceThresholdCountPercent	Integer	No	Alarm threshold for the downward fluctuation ratio of the number of successful instances. Alarm threshold for the upward fluctuation ratio of the number of failed instances.
InstanceThresholdCount	Integer	No	Cumulative instance number fluctuation threshold.
StabilizeThreshold	Integer	No	Stability threshold count (debounce configuration statistical cycle count).
StabilizeStatisticsCycle	Integer	No	Stability statistical cycle (anti-shake configuration statistical cycle count).
IsCumulant	Boolean	No	Specifies whether to use cumulative calculation. valid values: false (consecutive), true (cumulative).
InstanceCount	Integer	No	Cumulative number of instances for the current day. Specifies the downward fluctuation of failed instance count on the day.

ProjectRequest

This API is used to obtain project information.

Used by actions: CreateProject.

Name	Type	Required	Description
ProjectName	String	Yes	Project id, english name, starts with a letter, can contain letters, numbers, and underscores, and must not exceed 32 characters.
DisplayName	String	Yes	The project display name can be a chinese name, starts with a letter, and can contain letters, numbers, and underscores, with a maximum of 32 characters.
ProjectModel	String	No	Project mode, SIMPLE (default): SIMPLE mode STANDARD: STANDARD mode.

ProjectResult

Project returned results.

Used by actions: CreateProjectMember, DeleteProject, DisableProject, EnableProject.

Name	Type	Description
Status	Boolean	Returned result true/false.

ProjectUserRole

Project user object.

Used by actions: ListProjectMembers.

Name	Type	Description
AppId	String	Tenant ID Note: This field may return null, indicating that no valid values can be obtained.
RootAccountId	String	Host Account ID Note: This field may return null, indicating that no valid values can be obtained.
UserUin	String	User ID Note: This field may return null, indicating that no valid values can be obtained.
UserName	String	Username. Note: This field may return null, indicating that no valid values can be obtained.
DisplayName	String	Display name. Note: This field may return null, indicating that no valid values can be obtained.
Roles	Array of SystemRole	User role object. Note: This field may return null, indicating that no valid values can be obtained.
IsCreator	Boolean	Whether to create. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
IsProjectOwner	Boolean	Whether the project leader. Note: This field may return null, indicating that no valid values can be obtained.
PhoneNum	String	Mobile number. Note: This field may return null, indicating that no valid values can be obtained.
Email	String	Mailbox. Note: This field may return null, indicating that no valid values can be obtained.

ProjectUsersBrief

User collection under the project.

Used by actions: ListProjectMembers.

Name	Type	Description
Items	Array of ProjectUserRole	User collection. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Pagination size. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total page number. Note: This field may return null, indicating that no valid values can be obtained.

QualityRuleTemplate

Rule template.

Used by actions: ListQualityRuleTemplates.

Name	Type	Description
RuleTemplateId	Integer	Rule template ID.
Name	String	Rule template name.
Description	String	Rule template description.
Type	Integer	Template type (1: system template, 2: custom).
SourceObjectType	Integer	Applicable source data object type for rule (1: constant, 2: offline table level, 3: offline field level).
SourceObjectDataType	Integer	Applicable source data object type for rule (1: numeric value, 2: string).
SourceContent	String	Rule template source side content, case-sensitive, JSON structure. Note: This field may return null, indicating that no valid values can be obtained.
SourceEngineTypes	Array of Integer	Applicable source data type. Note: This field may return null, indicating that no valid values can be obtained.
QualityDim	Integer	Quality dimension of rule (1: accuracy, 2: uniqueness, 3: integrity, 4: consistency, 5: timeliness, 6: validity). Note: This field may return null, indicating that no valid values can be obtained.
CompareType	Integer	Supported comparison types for rule (1: fixed value comparison, more than, less than, equal to or greater than; 2: fluctuation value comparison, absolute value, rise, drop). Note: This field may return null, indicating that no valid values can be obtained.
CitationCount	Integer	Referenced times. Note: This field may return null, indicating that no valid values can be obtained.
UserId	Integer	Creator ID Note: This field may return null, indicating that no valid values can be obtained.
UserName	String	Creator nickname. Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime	String	Last update time yyyy-MM-dd HH:MM:ss. Note: This field may return null, indicating that no valid values can be obtained.
WhereFlag	Boolean	Whether to add where parameter. Note: This field may return null, indicating that no valid values can be obtained.
MultiSourceFlag	Boolean	Whether multiple database tables are associated. Note: This field may return null, indicating that no valid values can be obtained.
SqlExpression	String	Custom template SQL expression. Note: This field may return null, indicating that no valid values can be obtained.
SubQualityDim	Integer	Template sub-dimension, 0. parent dimension type, 1. consistency: enumeration range consistency, 2. consistency: numeric range consistency, 3. consistency: field data correlation. Note: This field may return null, indicating that no valid values can be obtained.
ResolvedSqlExpression	QualitySqlExpression	sql expression parsing object. Note: This field may return null, indicating that no valid values can be obtained.
DatasourceTypes	Array of Integer	Supported data source types. Note: This field may return null, indicating that no valid values can be obtained.
UserIdStr	String	Created by user id str. Note: This field may return null, indicating that no valid values can be obtained.

QualityRuleTemplatePage

RuleTemplatePage response parameters structure.

Used by actions: ListQualityRuleTemplates.

Name	Type	Description
TotalCount	Integer	Number of records.
Items	Array of QualityRuleTemplate	Template list.

QualitySqlExpression

sql expression parsing object for data quality custom rules.

Used by actions: ListQualityRuleTemplates.

Name	Type	Description
TableExpressions	Array of QualitySqlExpressionTable	sql expression table name. Note: This field may return null, indicating that no valid values can be obtained.
ParamExpressions	Array of String	sql expression field name. Note: This field may return null, indicating that no valid values can be obtained.
SystemTemplateExpressions	Array of String	Add model detection class system template sql placeholder collection. Note: This field may return null, indicating that no valid values can be obtained.

QualitySqlExpressionTable

Data quality custom rules sql expression parsing table object.

Used by actions: ListQualityRuleTemplates.

Name	Type	Description
TableExpression	String	sql expression table name. Note: This field may return null, indicating that no valid values can be obtained.
ColumnExpression	Array of String	sql expression field name. Note: This field may return null, indicating that no valid values can be obtained.

ReconciliationStrategyInfo

Offline integration reconciliation Alarm rule.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
RuleType	String	No	Offline Integration Task Reconciliation Alarms reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
MismatchCount	Integer	No	Reconciliation Mismatch Threshold - Required when RuleType = reconciliationMismatch. Specifies the threshold for the number of mismatched records in reconciliation. No default value.
Hour	Integer	No	Task run timeout threshold for reconciliation: hr, defaults to 0.
Min	Integer	No	Reconciliation task timeout threshold: minutes, defaults to 1.

RelateTask

Task info of data source.

Used by actions: GetDataSourceRelatedTasks.

Name	Type	Description
TaskType	String	Task type -OfflineIntegration --- offline integration task. -RealtimeIntegration --- real-time integration task. -DataDevelopment - data development task. -DataQuality - data quality tasks. -DataService - data service task. -MetadataCollection --- metadata collection task.
TaskNum	Integer	Number of Tasks
TaskList	Array of BriefTask	Task details. Note: This field may return null, indicating that no valid values can be obtained.

ResourceFile

Resource file details.

Used by actions: GetResourceFile.

Name	Type	Description
ProjectId	String	Project ID.
ResourceId	String	Resource file ID.
ResourceName	String	Resource file name.
LocalPath	String	Source file path.
RemotePath	String	Specifies the COS storage path of the resource object.
FileExtensionType	String	Specifies the resource file type.
Size	String	Resource size
CreatorUserUin	String	Creator user ID
CreatorUserName	String	Creator name
UpdateUserName	String	Last updated username.
UpdateUserUin	String	Last updated user ID.
BucketName	String	COS bucket.
CosRegion	String	COS region
ResourceSourceMode	String	Specifies the resource source mode.
BundleId	String	Local project ID.
BundleInfo	String	Local project information.

ResourceFileItem

Retrieve the resource file list item.

Used by actions: ListResourceFiles.

Name	Type	Description
ResourceId	String	Resource file ID.
ResourceName	String	Resource file name.
FileExtensionType	String	Specifies the resource file type.
LocalPath	String	Resource path

ResourceFilePage

Resource file pagination.

Used by actions: ListResourceFiles.

Name	Type	Description
Items	Array of ResourceFileItem	Task collection information.
TotalPageNumber	Integer	Total page number
TotalCount	Integer	Total file count.
PageNumber	Integer	Current Page number
PageSize	Integer	Items per Page

ResourceFolder

Resource folder details.

Used by actions: ListResourceFolders.

Name	Type	Description
FolderId	String	Resource folder ID.
CreateUserUin	String	Creator ID.
CreateUserName	String	Creator's name.
FolderPath	String	Specifies the folder path.
FolderName	String	Folder name.

ResourceFolderDetail

Resource folder details.

Used by actions: GetResourceFolder.

Name	Type	Description
FolderId	String	Resource folder ID.
CreateUserUin	String	Creator ID.
CreateUserName	String	Creator'S name.
FolderPath	String	Folder path.
FolderName	String	Folder name.
ParentFolderPath	String	Absolute path of the parent folder, excluding the folder name.
ProjectId	String	Project ID.

ResourceFolderPage

Resource folder page.

Used by actions: ListResourceFolders.

Name	Type	Description
Items	Array of ResourceFolder	Resource folder collection information.
TotalPageNumber	Integer	Total page number.
TotalCount	Integer	Total resource folder count
PageNumber	Integer	Current Page number
PageSize	Integer	Items per Page

ResourceGroupMetrics

Resource group monitoring metrics.

Used by actions: GetResourceGroupMetrics.

Name	Type	Description
CpuNum	Integer	Resource group specification, indicates the number of cpus. Note: This field may return null, indicating that no valid values can be obtained.
DiskVolume	Integer	Resource group specification related to disk specification. Note: This field may return null, indicating that no valid values can be obtained.
MemSize	Integer	Resource group specification related to memory size. unit: gb. Note: This field may return null, indicating that no valid values can be obtained.
LifeCycle	Integer	Resource group lifecycle. unit: day. Note: This field may return null, indicating that no valid values can be obtained.
MaximumConcurrency	Integer	Resource group specification related to highest concurrency. Note: This field may return null, indicating that no valid values can be obtained.
Status	Integer	Resource group status -0 - initializing. -1. running. -2 --- operation exception. -Releasing. -4 --- released. -Creating. -6 --- creation failed. -7 --- updating. -8 --- update failed. -9 --- expired. - 10 --- release failed. -11 --- in use. -12 --- inactive. Note: This field may return null, indicating that no valid values can be obtained.
MetricSnapshots	Array of MetricData	Metric detail.

ResourceGroupSpecification

Resource group specification.

Used by actions: CreateResourceGroup.

Name	Type	Required	Description
Specification	String	Yes	Resource group specification.
Number	Integer	Yes	Quantity.

ResourceNumber

Manipulate the number of resource packages.

Used by actions: UpdateResourceGroup.

Name	Type	Required	Description
Type	String	No	Add/Remove an enumeration. -ADD. -DELETE -- reduce.
Quantity	Integer	No	Add/Reduce the number of resource packages.

ResourcePrivilegeDetail

Used by actions: ListPermissions.

Name	Type	Required	Description
Resource	PrivilegeResource	No	Resource.
SubjectDetails	Array of SubjectInfo	No	Subject.
PermissionDetails	Array of PrivilegeInfo	No	Permission details.

ResourceResult

Operation result of the resource group.

Used by actions: CreateResourceGroup.

Name	Type	Description
Status	Boolean	Success status Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupId	String	Resource group ID Note: This field may return null, indicating that no valid values can be obtained.

ResourceStatus

Operation status of the resource group.

Used by actions: AssociateResourceGroupToProject, DeleteResourceGroup, DissociateResourceGroupFromProject, UpdateResourceGroup.

Name	Type	Description
Status	Boolean	Resource group operation status. Note: This field may return null, indicating that no valid values can be obtained.

ResourceType

Opened resource group information.

Used by actions: CreateResourceGroup.

Name	Type	Required	Description
ResourceGroupType	String	Yes	Resource group type -Schedule --- scheduling resource group. -Integration - integration resource group. -DataService - data service resource group.
Integration	IntegrationResource	No	Integration resource group, segmentation of real-time resource group and offline resource group (simultaneous purchase of integration, scheduling, and data service resource group not allowed).
Schedule	ResourceGroupSpecification	No	Scheduling resource group (simultaneous purchase of integration, scheduling, and data service resource groups is not allowed). -test specification. -S_small (basic specification). -S_medium (general specifications). -S_large (professional specification).
DataService	ResourceGroupSpecification	No	Data service resource group (seamless integration, scheduling, simultaneous purchase not allowed). -ds_t(Test specification). -ds_s (basic specification). -ds_m (general specifications). -ds_l (professional specification).

RevokePrivilegesRsp

Reclaim openapi authorization.

Used by actions: RevokePrivileges.

Name	Type	Description
OverallSuccess	Boolean	Result
Results	Array of AuthorizeResult	Detail list.

SQLContentActionResult

SQL exploration file/folder operation result.

Used by actions: DeleteSQLFolder, DeleteSQLScript, UpdateSQLFolder.

Name	Type	Description
Status	Boolean	Whether the operation is successful
FolderId	String	Folder ID.

SQLFolderNode

SQL script file tree node.

Used by actions: GetSQLFolder, ListSQLFolderContents.

Name	Type	Description
Id	String	Unique identifier
Name	String	Name
Type	String	folder type, script type.
ParentFolderPath	String	Parent folder path, such as /aaa/bbb/ccc. the path must start with a slash. use / for the root directory.
IsLeaf	Boolean	Whether it is a leaf node.
Params	String	Business parameters
AccessScope	String	Permission scope: SHARED, PRIVATE.
Path	String	Node path.
CreateUserUin	String	Creator
NodePermission	String	Specifies the permission of the current user for nodes.
Children	Array of SQLFolderNode	Sub-node list
OwnerUin	String	Owner of the file.

SQLScript

Explore data script business processing entity.

Used by actions: CreateSQLScript, GetSQLScript, UpdateSQLScript.

Name	Type	Description
ScriptId	String	Script id.
ScriptName	String	Script name.
OwnerUin	String	Specifies the script owner uin.
ParentFolderPath	String	Parent folder path, /aaa/bbb/ccc.
ScriptConfig	SQLScriptConfig	Specifies the script configuration.
ScriptContent	String	Specifies the script content.
UpdateUserUin	String	Latest operator.
ProjectId	String	Project ID.
UpdateTime	String	Update time. format: yyyy-MM-dd hh:MM:ss.
CreateTime	String	Creation time. format: yyyy-MM-dd hh:MM:ss.
AccessScope	String	Access permission: SHARED, PRIVATE.
Path	String	Full path of the node, /aaa/bbb/ccc.ipynb, consists of the name of each node.

SQLScriptConfig

Data exploration script configuration.

Used by actions: CreateSQLScript, GetSQLScript, UpdateSQLScript.

Name	Type	Required	Description
DatasourceId	String	No	Data source Id.
DatasourceEnv	String	No	Specifies the data source environment.
ComputeResource	String	No	Computational resource.
ExecutorGroupId	String	No	Specifies the execution resource group.
Params	String	No	Advanced running parameter variable replacement map-json String,String.
AdvanceConfig	String	No	Advanced setting. executes configuration parameters. map-json String,String. use Base64 encode.

SQLStopResult

Disable sql execution result.

Used by actions: StopSQLScriptRun.

Name	Type	Description
Status	Boolean	Success status

SchedulingParameter

Used by actions: CreateTriggerWorkflowRun, RerunTriggerWorkflowRunAsync.

Name	Type	Required
ParamKey	String	No
ParamValue	String	No
ExtProperties	String	No

SchemaInfo

Schema information.

Used by actions: ListSchema.

Name	Type	Required	Description
Guid	String	No	Schema GUID Note: This field may return null, indicating that no valid values can be obtained.
Name	String	No	Schema name. Note: This field may return null, indicating that no valid values can be obtained.
DatabaseName	String	No	Database name. Note: This field may return null, indicating that no valid values can be obtained.

SecurityFilter

filter used for data security.

Used by actions: ListPermissions.

Name	Type	Required	Description
Name	String	No	key
Values	Array of String	No	values

SqlCreateResult

Describes the return type of creating a data exploration script folder.

Used by actions: CreateSQLFolder.

Name	Type	Required	Description
FolderId	String	No	Folder ID

StartTasks

Batch start tasks response parameters.

Used by actions: StartOpsTasks.

Name	Type	Description
Status	Boolean	Whether the startup succeeded.

Subject

Subject entity information, authorize/reclaim entity.

Used by actions: AuthorizePrivileges, RevokePrivileges.

Name	Type	Required	Description
SubjectType	String	No	Type.
SubjectValues	Array of String	No	Subject list.

SubjectInfo

Used by actions: ListPermissions.

Name	Type	Required	Description
SubjectType	String	No	Type.
SubjectTypeDisplayName	String	No	Topic type display name.
SubjectValue	String	No	Subject id.
SubjectValueDisplayName	String	No	Subject name.

SubmitTaskResult

Submits the result of a data development task.

Used by actions: SubmitTask, SubmitTriggerTask.

Name	Type	Description
VersionId	String	Generated task version ID.
Status	Boolean	Submission status.

SystemRole

Role object.

Used by actions: ListProjectMembers, ListProjectRoles, ListTenantRoles.

Name	Type	Description
RoleId	String	Role id.
RoleName	String	Role name Note: This field may return null, indicating that no valid values can be obtained.
RoleDisplayName	String	Display name of the role. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Description Note: This field may return null, indicating that no valid values can be obtained.

TableInfo

Database information

Used by actions: GetTable, ListTable.

Name	Type	Required	Description
Guid	String	No	Data table GUID. Note: This field may return null, indicating that no valid values can be obtained.
Name	String	No	Data table name Note: This field may return null, indicating that no valid values can be obtained.
Description	String	No	Table description. Note: This field may return null, indicating that no valid values can be obtained.
DatabaseName	String	No	Database name. Note: This field may return null, indicating that no valid values can be obtained.
SchemaName	String	No	Schema name. Note: This field may return null, indicating that no valid values can be obtained.
TableType	String	No	Table type Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	No	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime	String	No	Update time Note: This field may return null, indicating that no valid values can be obtained.
TechnicalMetadata	TechnicalMetadata	No	Technical metadata of the table. Note: This field may return null, indicating that no valid values can be obtained.
BusinessMetadata	BusinessMetadata	No	Business metadata of the table. Note: This field may return null, indicating that no valid values can be obtained.
CatalogName	String	No	Data catalog. Note: This field may return null, indicating that no valid values can be obtained.
DatasourceId	Integer	No	Data source ID. Note: This field may return null, indicating that no valid values can be obtained.
DatasourceType	String	No	Data source type. Note: This field may return null, indicating that no valid values can be obtained.

Task

Task object.

Used by actions: GetOpsTask, GetTask, GetTaskVersion.

Name	Type	Required	Description
TaskBaseAttribute	TaskBaseAttribute	Yes	Describes the basic attributes of the task.
TaskConfiguration	TaskConfiguration	Yes	Task configurations.
TaskSchedulerConfiguration	TaskSchedulerConfiguration	Yes	Specifies task scheduling configuration.

TaskBaseAttribute

Describes the basic attribute information of the task.

Used by actions: GetOpsTask, GetTask, ListTasks.

Name	Type	Required	Description
TaskId	String	Yes	Task ID
TaskTypeId	Integer	Yes	Specifies the task type 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
WorkflowId	String	Yes	Workflow ID.
TaskName	String	No	Task name.
TaskLatestVersionNo	String	No	Last save version number.
TaskLatestSubmitVersionNo	String	No	Last submit version number.
WorkflowName	String	No	Workflow name.
Status	String	No	Task Status: * N: New * Y: Scheduling * F: Offline * O: Paused * T: Offlining (in the process of being taken offline) * INVALID: Invalid
Submit	Boolean	No	Latest submission status of the task. Specifies whether it has been submitted: true/false.
CreateTime	String	No	Task creation time. example: 2022-02-12 11:13:41.
LastUpdateTime	String	No	Last update time. example: 2025-08-13 16:34:06.
LastUpdateUserName	String	No	Last Updated By (Name).
LastOpsTime	String	No	Last operation time.
LastOpsUserName	String	No	Last operator name.
OwnerUin	String	No	Task owner ID.
TaskDescription	String	No	Task description
UpdateUserUin	String	No	Last Updated User ID
CreateUserUin	String	No	Created By User ID
TaskFolderPath	String	No	Task folder path. Note:. -Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" category, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. -If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for a successful operation. Note: This field may return null, indicating that no valid values can be obtained.

TaskCode

Task code.

Used by actions: GetOpsTaskCode.

Name	Type	Description
CodeContent	String	Specifies the code content.
CodeFileSize	Integer	Specifies the size of the code file in bytes.

TaskCodeResult

Task code.

Used by actions: GetTaskCode, GetTriggerTaskCode.

Name	Type	Description
CodeInfo	String	Code content.
CodeFileSize	String	Code file size. unit: KB.

TaskConfiguration

Task configuration information.

Used by actions: GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially.

Name	Type	Required	Description
CodeContent	String	No	Base64 encoding of the code content. Note: This field may return null, indicating that no valid values can be obtained.
TaskExtConfigurationList	Array of TaskExtParameter	No	Extended attribute configuration list of the task. Note: This field may return null, indicating that no valid values can be obtained.
DataCluster	String	No	Cluster ID Note: This field may return null, indicating that no valid values can be obtained.
BrokerIp	String	No	Specifies the specified running node. Note: This field may return null, indicating that no valid values can be obtained.
YarnQueue	String	No	Resource pool queue name. need to pass through DescribeProjectClusterQueues to obtain. Note: This field may return null, indicating that no valid values can be obtained.
SourceServiceId	String	No	Source data source ID, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
SourceServiceType	String	No	Data source type, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
SourceServiceName	String	No	Data source name, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
TargetServiceId	String	No	Target data source ID, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
TargetServiceType	String	No	Target data source type. need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
TargetServiceName	String	No	Target data source name, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroup	String	No	Resource group ID: need to pass through DescribeNormalSchedulerExecutorGroups to obtain ExecutorGroupId. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupName	String	No	Resource group name: need to pass through DescribeNormalSchedulerExecutorGroups to obtain ExecutorGroupName. Note: This field may return null, indicating that no valid values can be obtained.
TaskSchedulingParameterList	Array of TaskSchedulingParameter	No	Specifies the scheduling parameter. Note: This field may return null, indicating that no valid values can be obtained.
BundleId	String	No	ID used by the Bundle. Note: This field may return null, indicating that no valid values can be obtained.
BundleInfo	String	No	Bundle info. Note: This field may return null, indicating that no valid values can be obtained.

TaskDataRegistry

Task data registration item.

Used by actions: CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
DatasourceId	String	Yes	Data source ID.
DatabaseName	String	Yes	Database name.
TableName	String	Yes	Table name
PartitionName	String	Yes	Partition name
DataFlowType	String	Yes	Input output table data type. Input stream: UPSTREAM, Output stream: DOWNSTREAM;.
TablePhysicalId	String	Yes	Physical unique ID..
DbGuid	String	No	Database unique id..
TableGuid	String	No	Unique id of the table.

TaskDependDto

Describes the dependency task information.

Used by actions: ListDownstreamTasks, ListUpstreamTasks.

Name	Type	Description
TaskId	String	Task ID
TaskName	String	Task name.
WorkflowId	String	Workflow id.
WorkflowName	String	Workflow name.
ProjectId	String	Project ID.
Status	String	Task Status: * N: New * Y: Scheduling * F: Offline * O: Paused * T: Offlining (in the process of being taken offline) I* NVALID: Invalid
TaskTypeId	Integer	Task type id.
TaskTypeDesc	String	Task type description. -20 : universal data synchronization. - 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: branch. -131: merge. -132: Notebook -133: SSH node. - 134 : StarRocks - 137 : For-each -10000 : custom business common.
ScheduleDesc	String	Specifies scheduling plan display description information.
StartTime	String	Task start time.
EndTime	String	Task end time.
DelayTime	Integer	Delay time.
CycleType	String	Cycle Type, Default: D Supported types: * O: One-time * Y: Yearly * M: Monthly * W: Weekly * D: Daily * H: Hourly * I: Minute * C: Crontab expression type
OwnerUin	String	Owner ID
TaskAction	String	Elastic cycle configuration.
InitStrategy	String	Initialization strategy for scheduling.
CrontabExpression	String	crontab expression.

TaskExtParameter

Task extension information parameter.

Used by actions: CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
ParamKey	String	Yes	Parameter name.
ParamValue	String	Yes	Parameter value.

TaskFolder

Task folder info.

Used by actions: ListTaskFolders.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderId	String	Folder ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderPath	String	Folder absolute path. Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Creator ID. Note: This field may return null, indicating that no valid values can be obtained.

TaskFolderDetail

Task file detailed information.

Used by actions: GetTaskFolder.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderId	String	Folder ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderPath	String	Absolute path of the folder. Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Creator ID. Note: This field may return null, indicating that no valid values can be obtained.
ParentTaskFolderPath	String	Parent folder absolute path. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderName	String	Folder name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Workflow ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderType	String	Task folder type.

TaskFolderPage

Task file page.

Used by actions: ListTaskFolders.

Name	Type	Description
PageNumber	Integer	Number of data pages, equal to or greater than 1. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Number of records to display per page. valid values: `10` to `200`. Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of folders. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total pages Note: This field may return null, indicating that no valid values can be obtained.
Items	Array of TaskFolder	Folder list. Note: This field may return null, indicating that no valid values can be obtained.

TaskInstance

Scheduling task instance entity.

Used by actions: ListDownstreamTaskInstances, ListTaskInstances, ListUpstreamTaskInstances.

Name	Type	Description
ProjectId	String	Project id.
InstanceKey	String	Instance unique id.
FolderId	String	Folder ID.
FolderName	String	Folder name.
WorkflowId	String	Workflow ID.
WorkflowName	String	Workflow name.
TaskId	String	Task ID
TaskName	String	Task name.
CurRunDate	String	Instance data time.
InstanceState	String	Instance status. -WAIT_EVENT: specifies the wait for event. -WAIT_UPSTREAM: waiting for upstream. - WAIT_RUN: awaiting execution. - RUNNING: indicates the instance is RUNNING. - SKIP_RUNNING: SKIP RUNNING. - FAILED_RETRY: RETRY on failure. - EXPIRED: failed. -COMPLETED: success.
InstanceType	Integer	Specifies the instance type. -0 indicates the supplementary entry type. -Indicates a periodic instance. -2 indicates a non-periodic instance.
OwnerUinList	Array of String	Owner Uin list.
TotalRunNum	Integer	Cumulative running times.
TaskType	String	Task type description.
TaskTypeId	Integer	Task type id.
CycleType	String	Task Cycle Type * ONEOFF_CYCLE: One-time * YEAR_CYCLE: Yearly * MONTH_CYCLE: Monthly * WEEK_CYCLE: Weekly * DAY_CYCLE: Daily * HOUR_CYCLE: Hourly * MINUTE_CYCLE: Minute-level * CRONTAB_CYCLE: Crontab expression-based
TryLimit	Integer	Retry count limit when execution fails each time.
Tries	Integer	Specifies the number of retry attempts on failure. When triggered by manual rerun, supplementary entry instance, or other methods, the count will be reset to 0 and start again.
StartTime	String	Operation start time.
EndTime	String	Operation completion time.
CostTime	Integer	Time spent, in milliseconds.
SchedulerTime	String	Scheduled dispatch time.
LastUpdateTime	String	Latest update time of the instance. specifies the time format as yyyy-MM-dd HH:MM:ss.
ExecutorGroupId	String	Execution resource group ID.
ExecutorGroupName	String	Resource group name.

TaskInstanceDetail

Scheduling task instance details.

Used by actions: GetTaskInstance.

Name	Type	Description
ProjectId	String	Specifies the project id.
InstanceKey	String	Instance unique id.
FolderId	String	Folder ID.
FolderName	String	Specifies the folder name.
WorkflowId	String	Workflow ID.
WorkflowName	String	Workflow name.
TaskId	String	Task ID
TaskName	String	Task name.
TaskTypeId	Integer	Specifies the id corresponding to taskType.
TaskType	String	Task type
CycleType	String	Task Cycle Type * ONEOFF_CYCLE: One-time * YEAR_CYCLE: Yearly * MONTH_CYCLE: Monthly * WEEK_CYCLE: Weekly * DAY_CYCLE: Daily * HOUR_CYCLE: Hourly * MINUTE_CYCLE: Minute-level * CRONTAB_CYCLE: Crontab expression-based
CurRunDate	String	Specifies the instance data time.
InstanceState	String	Instance status. -WAIT_EVENT: wait for event. -WAIT_UPSTREAM: waiting for upstream. - WAIT_RUN: awaiting execution. -RUNNING. specifies the running status. - SKIP_RUNNING: specifies whether to SKIP RUNNING. - FAILED_RETRY: RETRY on failure. -EXPIRED: indicates a failure. -COMPLETED: success.
InstanceType	Integer	Specifies the instance type. -0 indicates the replenishment type. -Indicates a periodic instance. -2 indicates a non-periodic instance.
OwnerUinList	Array of String	owner uin list.
TotalRunNum	Integer	Cumulative running times.
TryLimit	Integer	Retry count limit when execution fails each time.
Tries	Integer	Failure Retry Count - The number of retry attempts after a failure. When the instance is triggered again through methods such as manual rerun or backfill, this counter is reset to 0 and starts counting again.
CostTime	Integer	Time spent, in milliseconds.
StartTime	String	Start time.
EndTime	String	Operation completion time.
SchedulerTime	String	Scheduled dispatch time.
LastUpdateTime	String	Latest update time of the instance. format: yyyy-MM-dd HH:MM:ss.
ExecutorGroupId	String	Execution resource group ID.
ExecutorGroupName	String	Resource group name.
JobErrorMsg	String	Brief task failure information.

TaskInstanceExecutions

Instance execution list.

Used by actions: ListTaskInstanceExecutions.

Name	Type	Description
TotalCount	Integer	Total number of results
TotalPageNumber	Integer	Total pages
Items	Array of InstanceExecution	Record list
PageNumber	Integer	Page number.
PageSize	Integer	Pagination size.

TaskInstancePage

Instance list pagination entity.

Used by actions: ListDownstreamTaskInstances, ListTaskInstances, ListUpstreamTaskInstances.

Name	Type	Description
TotalCount	Integer	Total number of entries.
TotalPageNumber	Integer	Total number of pages.
PageNumber	Integer	Page number.
PageSize	Integer	Specifies the number of entries per page.
Items	Array of TaskInstance	Data List

TaskOpsInfo

Describes the list details of the task operation and maintenance workflow.

Used by actions: ListOpsTasks.

Name	Type	Description
TaskId	String	Task ID
TaskName	String	Task name.
OwnerUin	String	Owner id
Status	String	Task Status -N: New -Y: Scheduling -F: Offline -O: Paused -T: Offlining -INVALID: Invalid
FolderId	String	Folder ID
FolderName	String	Folder name.
WorkflowId	String	Workflow id.
WorkflowName	String	Workflow name.
ProjectId	String	Project ID.
ProjectName	String	Project name.
UpdateUserUin	String	Specifies the name of the updater.
TaskTypeId	Integer	Task type 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
TaskTypeDesc	String	Task type description. -Universal data synchronization. - ETLTaskType - ETLTaskType - python - pyspark - HiveSQLTaskType - shell - SparkSQLTaskType - JDBCSQLTaskType - DLCTaskType - ImpalaTaskType - CDWTaskType - kettle - DLCSparkTaskType -TiOne machine learning. - TrinoTaskType - DLCPyspark - spark - mr -Specifies the shell script. -hivesql script. -Specifies common custom business.
CycleType	String	Task Cycle Type * ONEOFF_CYCLE: One-time * YEAR_CYCLE: Yearly * MONTH_CYCLE: Monthly * WEEK_CYCLE: Weekly * DAY_CYCLE: Daily * HOUR_CYCLE: Hourly * MINUTE_CYCLE: Minute-level * CRONTAB_CYCLE: Crontab expression-based
ExecutorGroupId	String	Resource group ID
ScheduleDesc	String	Scheduling description.
ExecutorGroupName	String	Resource group name.
LastSchedulerCommitTime	String	Latest scheduling submission time.
FirstRunTime	String	First execution time.
FirstSubmitTime	String	Most recent submission time.
CreateTime	String	Creation time.
LastUpdateTime	String	Latest update time.

TaskSchedulerConfiguration

Specifies task scheduling configuration info.

Used by actions: GetOpsTask, GetTask, UpdateTask, UpdateTaskPartially.

Name	Type	Required	Description
CycleType	String	No	Period type. Supported types: ONEOFF_CYCLE: specifies a one-time cycle. YEAR_CYCLE: specifies the year cycle. MONTH_CYCLE: specifies the monthly cycle. WEEK_CYCLE: specifies the week cycle. DAY_CYCLE: specifies the day cycle. HOUR_CYCLE: specifies the hour cycle. MINUTE_CYCLE: specifies the minute cycle. CRONTAB_CYCLE: specifies the crontab expression type
ScheduleTimeZone	String	No	Time zone.
CrontabExpression	String	No	0 2 3 1,L,2 * ?
StartTime	String	No	Effective date.
EndTime	String	No	End date
ExecutionStartTime	String	No	Execution time. the left-closed interval.
ExecutionEndTime	String	No	Execution time. right closed interval.
CalendarOpen	String	No	Whether calendar scheduling is enabled. Valid values: 1 (enabled), 0 (disabled).
CalendarId	String	No	Calendar id.
CalendarName	String	No	Calendar name, which needs to be obtained from DescribeScheduleCalendarPageList API.
SelfDepend	String	No	Self-Dependent. Valid values: parallel, serial, orderly. Default value: serial.
UpstreamDependencyConfigList	Array of DependencyTaskBrief	No	Specifies the upstream dependency array.
DownstreamDependencyConfigList	Array of DependencyTaskBrief	No	Downstream dependency array. Note: This field may return null, indicating that no valid values can be obtained.
EventListenerList	Array of EventListener	No	Array of Events
AllowRedoType	String	No	Rerun & Refill Configuration: Default: ALL; * ALL: Rerun or refill is allowed regardless of whether the task succeeds or fails. * FAILURE: Rerun or refill is allowed only if the task fails; not allowed if the task succeeds. * NONE: Rerun or refill is not allowed regardless of success or failure.
ParamTaskOutList	Array of OutTaskParameter	No	Output parameter list.
ParamTaskInList	Array of InTaskParameter	No	Input parameter list.
TaskOutputRegistryList	Array of TaskDataRegistry	No	Output registration.
InitStrategy	String	No	Instance generation policy. T_PLUS_0: specifies t+0 generation. default policy. T_PLUS_1: specifies t+1 generation.
ScheduleType	Integer	No	Scheduling type: 0 normal scheduling 1 dry-run scheduling, defaults to 0. Note: This field may return null, indicating that no valid values can be obtained.
RunPriorityType	Integer	No	Task scheduling priority execution priority 4 high 5 medium 6 low, default: 6. Note: This field may return null, indicating that no valid values can be obtained.
RetryWaitMinute	Integer	No	Retry policy retry wait time, in minutes: default: 5. Note: This field may return null, indicating that no valid values can be obtained.
MaxRetryNumber	Integer	No	Retry policy maximum attempts. default: 4. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionTTLMinute	Integer	No	Timeout handling strategy runtime timeout (unit: minutes) defaults to -1. Note: This field may return null, indicating that no valid values can be obtained.
WaitExecutionTotalTTLMinute	Integer	No	Timeout handling strategy wait for the total duration timeout (measurement unit: minutes) defaults to -1. Note: This field may return null, indicating that no valid values can be obtained.

TaskSchedulingParameter

Scheduling variable parameter.

Used by actions: CreateTask, CreateTriggerTask, GetOpsTask, GetTask, GetTriggerTask, UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
ParamKey	String	Yes	Parameter name.
ParamValue	String	Yes	Parameter value.

TaskVersion

Describes the version list information of the task.

Used by actions: ListTaskVersions.

Name	Type	Description
CreateTime	String	Creation time
VersionNum	String	Version number
CreateUserUin	String	Creator ID
VersionId	String	Saved version ID
VersionRemark	String	Version description
ApproveStatus	String	Approval status (only for submit version).
Status	String	Production status (only for submit version).
ApproveUserUin	String	Approver (only for submit version).

TaskVersionDetail

Describes the version list information of the task.

Used by actions: GetTaskVersion.

Name	Type	Description
CreateTime	String	Creation time.
VersionNum	String	Version number
CreateUserUin	String	Specifies the version creator.
VersionId	String	Specifies the version Id to save.
VersionRemark	String	Version description
ApproveStatus	String	Approval status (only for submit version).
ApproveTime	String	Production status (only for submit version).
Task	Task	Describes the task detail of the version.
ApproveUserUin	String	Approver Id.

TechnicalMetadata

Used by actions: GetTable, ListTable.

Name	Type	Required	Description
Owner	String	No	Responsible person. Note: This field may return null, indicating that no valid values can be obtained.
Location	String	No	Data table location. Note: This field may return null, indicating that no valid values can be obtained.
StorageSize	Integer	No	Storage size Note: This field may return null, indicating that no valid values can be obtained.

TimeOutStrategyInfo

Alarm timeout configuration rule information.

Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, UpdateOpsAlarmRule.

Name	Type	Required	Description
RuleType	Integer	No	Timeout Alarm Configuration Expected Execution Duration Timeout - The actual runtime exceeds the estimated execution duration. Expected Completion Time Timeout - The task has not completed by the estimated completion time. Expected Scheduling Wait Timeout - The waiting time in the scheduling queue exceeds the estimated wait time. Cycle-Incomplete Timeout - The task was expected to complete within its scheduled cycle but did not.
Type	Integer	No	Timeout Value Configuration Type 1: Fixed value (specified manually) 2: Average value (calculated automatically)
Hour	Integer	No	Timeout Specified Value (hours) - The timeout threshold in hours. Default is 1.
Min	Integer	No	Timeout Specified Value (minutes) - The timeout threshold in minutes. Default is 1.
ScheduleTimeZone	String	No	The time zone configuration corresponding to the timeout, such as UTC+7, defaults to UTC+8.
Second	Integer	No	Seconds (for Spark Streaming policy). Note: This field may return null, indicating that no valid values can be obtained.
Times	Integer	No	Count (for Spark Streaming retry count limit policy, ruleType=10). Note: This field may return null, indicating that no valid values can be obtained.
AlarmTriggerFrequency	Integer	No	Alarm trigger frequency (for Spark Streaming policy ruleType=8/9/10). Unit: minute. value range: 5-1440. After an Alarm is triggered, pause detection during this period to avoid an Alarm storm. Note: This field may return null, indicating that no valid values can be obtained.

TrendData

Resource group metrics trend.

Used by actions: GetResourceGroupMetrics.

Name	Type	Description
Timestamp	Integer	Timestamp.
Value	Integer	Metric value.

TriggerDependencyConfigPage

Query task upstream dependency details paginate.

Used by actions: ListDownstreamTriggerTasks, ListUpstreamTriggerTasks.

Name	Type	Description
TotalCount	Integer	Total number of data entries that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Total number of pages that meet the query condition. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Current request data page. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Number of entries in the current request. Note: This field may return null, indicating that no valid values can be obtained.
Items	Array of TriggerTaskDependDto	Paging data Note: This field may return null, indicating that no valid values can be obtained.

TriggerTask

Task object.

Used by actions: GetTriggerTask, GetTriggerTaskVersion.

Name	Type	Required	Description
TriggerTaskBaseAttribute	TriggerTaskBaseAttribute	Yes	Task basic attributes. Note: This field may return null, indicating that no valid values can be obtained.
TriggerTaskConfiguration	TriggerTaskConfiguration	Yes	Task configurations. Note: This field may return null, indicating that no valid values can be obtained.
TriggerTaskSchedulerConfiguration	TriggerTaskSchedulerConfiguration	Yes	Task scheduling configuration. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskBaseAttribute

Task basic attribute information.

Used by actions: GetTriggerTask, ListTriggerTasks.

Name	Type	Required	Description
TaskId	String	Yes	Task ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeId	Integer	Yes	Task type 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 Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Yes	Workflow ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskName	String	No	Task name. Note: This field may return null, indicating that no valid values can be obtained.
TaskLatestVersionNo	String	No	Last saved version no. Note: This field may return null, indicating that no valid values can be obtained.
TaskLatestSubmitVersionNo	String	No	Version no. of last submission. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	No	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
Status	String	No	Task status:. * N: create. * Y: scheduling in progress. Note: This field may return null, indicating that no valid values can be obtained.
Submit	Boolean	No	Latest submission status of the task, whether it has been submitted: true/false. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	No	Task creation time, for example: 2022-02-12 11:13:41. Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTime	String	No	Last update time, for example: 2025-08-13 16:34:06. Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateUserName	String	No	Last updated by name. Note: This field may return null, indicating that no valid values can be obtained.
LastOpsTime	String	No	Last maintenance time. Note: This field may return null, indicating that no valid values can be obtained.
LastOpsUserName	String	No	Last operator name. Note: This field may return null, indicating that no valid values can be obtained.
OwnerUin	String	No	Task owner ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskDescription	String	No	Task description Note: This field may return null, indicating that no valid values can be obtained.
UpdateUserUin	String	No	Latest update uid. Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	No	Create a user ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskFolderPath	String	No	Task folder path. Note:. Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" category, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for a successful operation. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskBrief

Task summary information.

Used by actions: GetOpsTriggerWorkflow.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
ProjectName	String	Project name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Workflow id. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
TaskId	String	Task ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskName	String	Task name. Note: This field may return null, indicating that no valid values can be obtained.
TaskType	String	Task type Note: This field may return null, indicating that no valid values can be obtained.
UserUinInCharge	String	Responsible person user UIN. Note: This field may return null, indicating that no valid values can be obtained.
UserNameInCharge	String	Responsible person's name. Note: This field may return null, indicating that no valid values can be obtained.
FolderId	String	Folder ID. Note: This field may return null, indicating that no valid values can be obtained.
FolderName	String	Folder name. Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeId	Integer	Task type ID. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionState	String	Task status. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionStartTime	String	Start time. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskConfiguration

Task configuration information.

Used by actions: GetTriggerTask, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
CodeContent	String	No	Base64 encoding of the code content. Note: This field may return null, indicating that no valid values can be obtained.
TaskExtConfigurationList	Array of TaskExtParameter	No	Task extended attribute configuration list. Note: This field may return null, indicating that no valid values can be obtained.
DataCluster	String	No	Cluster ID Note: This field may return null, indicating that no valid values can be obtained.
BrokerIp	String	No	Specified running node. Note: This field may return null, indicating that no valid values can be obtained.
YarnQueue	String	No	Resource pool queue name. need to pass through DescribeProjectClusterQueues to obtain. Note: This field may return null, indicating that no valid values can be obtained.
SourceServiceId	String	No	Source data source ID, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
SourceServiceType	String	No	Data source type, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
SourceServiceName	String	No	Data source name, need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
TargetServiceId	String	No	Target data source ID. need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
TargetServiceType	String	No	Target data source type. need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
TargetServiceName	String	No	Target data source name. need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroup	String	No	Resource group ID: need to pass through DescribeNormalSchedulerExecutorGroups to obtain ExecutorGroupId. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupName	String	No	Resource group name: need to pass through DescribeNormalSchedulerExecutorGroups to obtain ExecutorGroupName. Note: This field may return null, indicating that no valid values can be obtained.
TaskSchedulingParameterList	Array of TaskSchedulingParameter	No	Scheduling parameter. Note: This field may return null, indicating that no valid values can be obtained.
BundleId	String	No	ID used by the Bundle. Note: This field may return null, indicating that no valid values can be obtained.
BundleInfo	String	No	Bundle info. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskDAGBrief

Workflow task summary information.

Used by actions: GetOpsTriggerWorkflow.

Name	Type	Description
TriggerTasks	Array of TriggerTaskBrief	Task information collection. Note: This field may return null, indicating that no valid values can be obtained.
TriggerTaskLinks	Array of TriggerTaskLinkBrief	Task connection information collection. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskDependDto

Dependent workflow scheduling task information.

Used by actions: ListDownstreamTriggerTasks, ListUpstreamTriggerTasks.

Name	Type	Description
TaskId	String	Task ID Note: This field may return null, indicating that no valid values can be obtained.
TaskName	String	Task name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Workflow id. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
Status	String	Task status:. -Running. -Create. Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeId	Integer	Task type id. Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeDesc	String	Task type description. -20: common data sync. - 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: branch. -131: merge. -132: Notebook explore. -133: SSH node. - 134 : StarRocks - 137 : For-each -10000 : custom business common. Note: This field may return null, indicating that no valid values can be obtained.
OwnerUin	String	Person in charge. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskLinkBrief

Task link summary information.

Used by actions: GetOpsTriggerWorkflow.

Name	Type	Description
LinkId	String	Connection ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Workflow ID Note: This field may return null, indicating that no valid values can be obtained.
WorkflowVersionId	String	Workflow version ID. Note: This field may return null, indicating that no valid values can be obtained.
UpstreamTaskId	String	Upstream task ID. Note: This field may return null, indicating that no valid values can be obtained.
DownstreamTaskId	String	Downstream task ID. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskRunBrief

Summary information of task running in workflow scheduling mode.

Used by actions: GetTriggerTaskRun, GetTriggerWorkflowRun.

Name	Type	Description
ExecutionId	String	Running ID. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionState	String	Execution status: FAILED (FAILED to run), SUCCESS (executed successfully), PENDING (waiting), SKIP (SKIP RUNNING), RUNNING (RUNNING). Note: This field may return null, indicating that no valid values can be obtained.
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Workflow ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowExecutionId	String	Running ID of the workflow. Note: This field may return null, indicating that no valid values can be obtained.
TaskId	String	Task ID. Note: This field may return null, indicating that no valid values can be obtained.
TaskType	String	Task type Note: This field may return null, indicating that no valid values can be obtained.
TaskVersionId	String	Task version. Note: This field may return null, indicating that no valid values can be obtained.
TriggerType	String	Trigger Type Note: This field may return null, indicating that no valid values can be obtained.
WaitTime	String	Waiting duration, in seconds. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroup	String	Associated resource group. Note: This field may return null, indicating that no valid values can be obtained.
ErrorCode	String	Error code Note: This field may return null, indicating that no valid values can be obtained.
ExecuteUserUin	String	Operating account. Note: This field may return null, indicating that no valid values can be obtained.
CreaterUin	String	Creator ID. Note: This field may return null, indicating that no valid values can be obtained.
JobId	String	Execution ID of the execution platform. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation Timestamp Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime	String	Update Timestamp Note: This field may return null, indicating that no valid values can be obtained.
DependenceFinishedTime	String	Task completion time dependency. Note: This field may return null, indicating that no valid values can be obtained.
QueueStartTime	String	Task delivery time to the execution platform. Note: This field may return null, indicating that no valid values can be obtained.
PendingStartTime	String	Started waiting for source time. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionStartTime	String	Start time. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionEndTime	String	Running end time. Note: This field may return null, indicating that no valid values can be obtained.
QueueCostTime	String	Queuing time. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionTime	String	Running time Note: This field may return null, indicating that no valid values can be obtained.
AllCostTime	String	Total time spent. Note: This field may return null, indicating that no valid values can be obtained.
TimeZone	String	Time zone. Note: This field may return null, indicating that no valid values can be obtained.
DependOnList	Array of String	Depends on the upstream task ID list. Note: This field may return null, indicating that no valid values can be obtained.
RunParams	String	Running parameter. Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeExtensions	String	Task extension information, including script path. Note: This field may return null, indicating that no valid values can be obtained.
RetryTimes	Integer	Retry count. it indicates the first run when set to 0. Note: This field may return null, indicating that no valid values can be obtained.
LeftCoordinate	Float	Left coordinate. Note: This field may return null, indicating that no valid values can be obtained.
TopCoordinate	Float	Top coordinate. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupId	String	Resource group ID. Note: This field may return null, indicating that no valid values can be obtained.
ErrorCodeStr	String	Error code description Note: This field may return null, indicating that no valid values can be obtained.
CreateUin	String	Creator UIN. Note: This field may return null, indicating that no valid values can be obtained.
IssueTime	String	Issue the execution platform time. Note: This field may return null, indicating that no valid values can be obtained.
TaskName	String	Task name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
ExecuteUserName	String	Operator name. Note: This field may return null, indicating that no valid values can be obtained.
RerunTimes	Integer	Number of retries. Note: This field may return null, indicating that no valid values can be obtained.
IsLatestExecution	Boolean	Whether it is the most recent run. Note: This field may return null, indicating that no valid values can be obtained.
TaskExecutionState	String	Task running status. Note: This field may return null, indicating that no valid values can be obtained.
CycleType	String	Cycle type. Note: This field may return null, indicating that no valid values can be obtained.
UserNameInCharge	String	Responsible person's name. Note: This field may return null, indicating that no valid values can be obtained.
UserUinInCharge	String	Responsible person id. Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupName	String	Resource group name. Note: This field may return null, indicating that no valid values can be obtained.
Timezone	String	Time zone. Note: This field may return null, indicating that no valid values can be obtained.
FolderId	String	Folder ID Note: This field may return null, indicating that no valid values can be obtained.
FolderName	String	Folder name. Note: This field may return null, indicating that no valid values can be obtained.
ProjectName	String	Project name. Note: This field may return null, indicating that no valid values can be obtained.
TaskTypeId	Integer	Task type id. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowParams	String	Workflow running parameter. Note: This field may return null, indicating that no valid values can be obtained.
SupportRerun	Boolean	Whether rerun is supported. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowExecutionState	String	Workflow execution status. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionResult	String	Task execution result. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskSchedulerConfiguration

Task scheduling configuration information.

Used by actions: GetTriggerTask, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Required	Description
UpstreamDependencyConfigList	Array of DependencyTriggerTaskBrief	No	Upstream dependency array. Note: This field may return null, indicating that no valid values can be obtained.
RunPriorityType	Integer	No	Task scheduling priority. execution priority. valid values: 4 (high), 5 (medium), 6 (low). default: 6. Note: This field may return null, indicating that no valid values can be obtained.
RetryWaitMinute	Integer	No	Retry policy retry wait time, in minutes: default: 5. Note: This field may return null, indicating that no valid values can be obtained.
MaxRetryNumber	Integer	No	Retry policy maximum attempts. default: 4. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionTTLMinute	Integer	No	Timeout handling strategy runtime timeout (unit: minutes) defaults to -1. Note: This field may return null, indicating that no valid values can be obtained.
WaitExecutionTotalTTLMinute	Integer	No	Timeout handling strategy wait duration timeout (unit: minutes) defaults to -1. Note: This field may return null, indicating that no valid values can be obtained.
AllowRedoType	String	No	Rerun & replenishment configuration, defaults to ALL. ALL allows rerun or replenishment after successful or failed running. FAILURE does not allow rerun or replenishment after successful running but allows after failed running. NONE does not allow rerun or replenishment after either successful or failed running. Note: This field may return null, indicating that no valid values can be obtained.
ParamTaskOutList	Array of OutTaskParameter	No	Output parameter array. Note: This field may return null, indicating that no valid values can be obtained.
ParamTaskInList	Array of InTaskParameter	No	Input parameter array. Note: This field may return null, indicating that no valid values can be obtained.
TaskOutputRegistryList	Array of TaskDataRegistry	No	Output registration. Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskVersion

Version list information.

Used by actions: ListTriggerTaskVersions.

Name	Type	Description
CreateTime	String	Retention time. Note: This field may return null, indicating that no valid values can be obtained.
VersionNum	String	Version Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Creator Note: This field may return null, indicating that no valid values can be obtained.
VersionId	String	Save version id. Note: This field may return null, indicating that no valid values can be obtained.
VersionRemark	String	Version description Note: This field may return null, indicating that no valid values can be obtained.
ApproveStatus	String	Approval status (only submit version has). Note: This field may return null, indicating that no valid values can be obtained.
Status	String	Production status (only submit version has). Note: This field may return null, indicating that no valid values can be obtained.
ApproveUserUin	String	Approver (only submit version has). Note: This field may return null, indicating that no valid values can be obtained.

TriggerTaskVersionDetail

Version list information.

Used by actions: GetTriggerTaskVersion.

Name	Type	Description
CreateTime	String	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
VersionNum	String	Version Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Creator of the version. Note: This field may return null, indicating that no valid values can be obtained.
VersionId	String	Save version Id. Note: This field may return null, indicating that no valid values can be obtained.
VersionRemark	String	Version description Note: This field may return null, indicating that no valid values can be obtained.
ApproveStatus	String	Approval status (only submit version has). Note: This field may return null, indicating that no valid values can be obtained.
ApproveTime	String	Production status (only submit version has). Note: This field may return null, indicating that no valid values can be obtained.
ApproveUserUin	String	Approver Id. Note: This field may return null, indicating that no valid values can be obtained.
Task	TriggerTask	Task detail of the version. Note: This field may return null, indicating that no valid values can be obtained.

TriggerWorkflowBrief

Workflow summary information.

Used by actions: ListOpsTriggerWorkflows.

Name	Type	Description
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Task ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
TaskCount	Integer	Number of Tasks Note: This field may return null, indicating that no valid values can be obtained.
FolderId	String	Folder ID. Note: This field may return null, indicating that no valid values can be obtained.
FolderName	String	Folder name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowTriggerConfig	WorkflowTriggerConfig	Scheduling configuration. Note: This field may return null, indicating that no valid values can be obtained.
UserNameInCharge	String	Responsible person. Note: This field may return null, indicating that no valid values can be obtained.
UserUinInCharge	String	Responsible person ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowParams	String	Workflow parameter.

TriggerWorkflowDetail

Query workflow details.

Used by actions: GetTriggerWorkflow.

Name	Type	Description
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
OwnerUin	String	Responsible person ID. Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Creator ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowParams	Array of ParamInfo	Workflow parameter array. Note: This field may return null, indicating that no valid values can be obtained.
TriggerWorkflowSchedulerConfigurations	Array of WorkflowTriggerConfig	Unify scheduling parameters. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowDesc	String	Workflow description. Note: This field may return null, indicating that no valid values can be obtained.
Path	String	Workflow path. Note: This field may return null, indicating that no valid values can be obtained.
BundleId	String	BundleId item. Note: This field may return null, indicating that no valid values can be obtained.
BundleInfo	String	BundleInfo item. Note: This field may return null, indicating that no valid values can be obtained.
GeneralTaskParams	Array of WorkflowGeneralTaskParam	General parameter. Note: This field may return null, indicating that no valid values can be obtained.
SchedulerStatus	String	Trigger status: ACTIVE (start), PAUSED (suspend). Note: This field may return null, indicating that no valid values can be obtained.

TriggerWorkflowInfo

Retrieve workflow list information.

Used by actions: ListTriggerWorkflows.

Name	Type	Description
WorkflowId	String	Workflow ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
OwnerUin	String	Person in Charge ID Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time. Note: This field may return null, indicating that no valid values can be obtained.
ModifyTime	String	Last Modification Time Note: This field may return null, indicating that no valid values can be obtained.
UpdateUserUin	String	Last updated by user ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowDesc	String	Workflow description. Note: This field may return null, indicating that no valid values can be obtained.
CreateUserUin	String	Creator ID. Note: This field may return null, indicating that no valid values can be obtained.

TriggerWorkflowResult

Query workflow list.

Used by actions: ListOpsTriggerWorkflows.

Name	Type	Description
TotalCount	Integer	Total number of records Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Number of pages. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Page size. Note: This field may return null, indicating that no valid values can be obtained.
Items	Array of TriggerWorkflowBrief	Workflow information collection. Note: This field may return null, indicating that no valid values can be obtained.

TriggerWorkflowRunBrief

Workflow operation summary information.

Used by actions: GetTriggerWorkflowRun, ListTriggerWorkflowRuns.

Name	Type	Description
AppId	String	User AppId Note: This field may return null, indicating that no valid values can be obtained.
ProjectId	String	Project ID. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowName	String	Workflow name. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowId	String	Workflow ID. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionId	String	Workflow running ID. Note: This field may return null, indicating that no valid values can be obtained.
TriggerId	String	Trigger ID. Note: This field may return null, indicating that no valid values can be obtained.
TriggerType	String	Trigger mode: scheduling trigger Scheduler, manual trigger ManualTrigger, Event trigger Event. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Workflow trigger time. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionStartTime	String	Execution start timestamp. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionEndTime	String	Execution end timestamp. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionCostTime	String	Running time, in seconds. Note: This field may return null, indicating that no valid values can be obtained.
QueueCostTime	String	Concurrent queue time taken, in seconds. Note: This field may return null, indicating that no valid values can be obtained.
PendingCostTime	String	Wait time for resource spending, in seconds. Note: This field may return null, indicating that no valid values can be obtained.
ExecutionState	String	Execution status: execution FAILED: FAILED, operation successful: SUCCESS, waiting: PENDING, skip RUNNING: SKIPED, RUNNING: RUNNING. Note: This field may return null, indicating that no valid values can be obtained.
ExecuteUserUin	String	Running user UIN. Note: This field may return null, indicating that no valid values can be obtained.
ExecuteUserName	String	Running username. Note: This field may return null, indicating that no valid values can be obtained.
ErrorCodeStr	String	Error code Note: This field may return null, indicating that no valid values can be obtained.
WorkflowParams	String	Running parameter. Note: This field may return null, indicating that no valid values can be obtained.
WorkflowVersionId	String	Workflow version info ID. Note: This field may return null, indicating that no valid values can be obtained.
SupportRerun	Boolean	Whether rerun is supported. Note: This field may return null, indicating that no valid values can be obtained.
RerunTimes	Integer	Number of reruns. Note: This field may return null, indicating that no valid values can be obtained.
SelectedTaskIds	Array of String	Running task scope, comma-separated task ID list. Note: This field may return null, indicating that no valid values can be obtained.
PendingStartTime	String	Start time of pending concurrency. Note: This field may return null, indicating that no valid values can be obtained.
QueueStartTime	String	Queued waiting start time. Note: This field may return null, indicating that no valid values can be obtained.
EndTime	String	Running end time. Note: This field may return null, indicating that no valid values can be obtained.
FolderId	String	Folder ID. Note: This field may return null, indicating that no valid values can be obtained.
FolderName	String	Folder name. Note: This field may return null, indicating that no valid values can be obtained.
PlannedSchedulingTime	String	Planned scheduling time. Note: This field may return null, indicating that no valid values can be obtained.
CycleType	String	Cycle type. Note: This field may return null, indicating that no valid values can be obtained.
UserNameInCharge	String	Responsible person's name. Note: This field may return null, indicating that no valid values can be obtained.
UserUinInCharge	String	Responsible person ID. Note: This field may return null, indicating that no valid values can be obtained.

TriggerWorkflowRunResult

Query workflow results.

Used by actions: ListTriggerWorkflowRuns.

Name	Type	Description
TotalCount	Integer	Total number of records Note: This field may return null, indicating that no valid values can be obtained.
TotalPageNumber	Integer	Number of pages. Note: This field may return null, indicating that no valid values can be obtained.
PageNumber	Integer	Page number Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Page size. Note: This field may return null, indicating that no valid values can be obtained.
Items	Array of TriggerWorkflowRunBrief	Workflow running and task running information collection. Note: This field may return null, indicating that no valid values can be obtained.

TriggerWorkflowTaskRunDetailBrief

Workflow task execution details.

Used by actions: GetTriggerWorkflowRun.

Name	Type	Description
TriggerWorkflowRun	TriggerWorkflowRunBrief	Workflow running information.
TriggerTaskRuns	Array of TriggerTaskRunBrief	Task running information.
BizStateEnumInfos	Array of BizStateEnumInfoBrief	Business status enumeration info.

UpdateFolderResult

Specifies the update folder result.

Used by actions: UpdateResourceFolder, UpdateWorkflowFolder.

Name	Type	Description
Status	Boolean	Update status. true indicates update succeeded. false indicates update failed.

UpdateResourceFileResult

Update resource file result.

Used by actions: UpdateResourceFile.

Name	Type	Description
Status	Boolean	true

UpdateTaskBaseAttribute

Updates the basic attribute information of the task.

Used by actions: UpdateTask.

Name	Type	Required	Description
TaskName	String	Yes	Task name.
OwnerUin	String	Yes	Task owner ID.
TaskDescription	String	Yes	Task description
TaskFolderPath	String	No	Note:. -Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" category, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. -If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for a successful operation.

UpdateTaskBaseAttributePart

Update task basic attribute information.

Used by actions: UpdateTaskPartially.

Name	Type	Required	Description
TaskName	String	No	Task name.
OwnerUin	String	No	Task owner ID.
TaskDescription	String	No	Task description
TaskFolderPath	String	No	Note:. -Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" classification, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. -If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for the operation to succeed.

UpdateTaskBrief

Update task object input parameters.

Used by actions: UpdateTask.

Name	Type	Required	Description
TaskBaseAttribute	UpdateTaskBaseAttribute	Yes	Describes the basic attributes of the task.
TaskConfiguration	TaskConfiguration	Yes	Task configurations.
TaskSchedulerConfiguration	TaskSchedulerConfiguration	Yes	Task scheduling configuration.

UpdateTaskFolderResult

Update folder result.

Used by actions: UpdateTaskFolder.

Name	Type	Description
Status	Boolean	Update status. true indicates update succeeded, false indicates update failed.

UpdateTaskPart

Update task object input parameters.

Used by actions: UpdateTaskPartially.

Name	Type	Required	Description
TaskBaseAttribute	UpdateTaskBaseAttributePart	No	Task basic attributes.
TaskConfiguration	TaskConfiguration	No	Task configurations.
TaskSchedulerConfiguration	TaskSchedulerConfiguration	No	Task scheduling configuration.

UpdateTaskResult

Update task response parameters structure.

Used by actions: UpdateTask, UpdateTaskPartially, UpdateTriggerTask, UpdateTriggerTaskPartially.

Name	Type	Description
Status	Boolean	Processing result. returns true on success. returns false on failure.

UpdateTasksOwner

Describes the result of batch modifying the task owner.

Used by actions: UpdateOpsTasksOwner.

Name	Type	Description
Status	Boolean	Describes the result of modifying the task owner.

UpdateTriggerTaskBaseAttribute

Update task basic attribute information.

Used by actions: UpdateTriggerTask.

Name	Type	Required	Description
TaskName	String	Yes	Task name.
OwnerUin	String	Yes	Task owner ID.
TaskDescription	String	Yes	Task description
TaskFolderPath	String	No	Note:. -Do not fill in the task node type in the path. for example, in a workflow named wf01, under the "common" classification, if you want to create a new shell task under the tf_01 folder in this classification, just fill in /tf_01. -If the tf_01 folder does not exist, first create this folder (use the CreateTaskFolder api) for the operation to succeed.

UpdateTriggerTaskBaseAttributePart

Update task basic attribute information.

Used by actions: UpdateTriggerTaskPartially.

Name	Type	Required	Description
TaskName	String	No	Task name.
OwnerUin	String	No	Task owner ID.
TaskDescription	String	No	Task description

UpdateTriggerTaskBrief

Update task object input parameters.

Used by actions: UpdateTriggerTask.

Name	Type	Required	Description
TriggerTaskBaseAttribute	UpdateTriggerTaskBaseAttribute	Yes	Task basic attributes.
TriggerTaskConfiguration	TriggerTaskConfiguration	Yes	Task configurations.
TriggerTaskSchedulerConfiguration	TriggerTaskSchedulerConfiguration	Yes	Task scheduling configuration.

UpdateTriggerTaskPart

Update task object input parameters.

Used by actions: UpdateTriggerTaskPartially.

Name	Type	Required	Description
TriggerTaskBaseAttribute	UpdateTriggerTaskBaseAttributePart	No	Task basic attributes.
TriggerTaskConfiguration	TriggerTaskConfiguration	No	Task configurations.
TriggerTaskSchedulerConfiguration	TriggerTaskSchedulerConfiguration	No	Task scheduling configuration.

UpdateTriggerWorkflowPartially

Query workflow details.

Used by actions: UpdateTriggerWorkflowPartially.

Name	Type	Required	Description
WorkflowName	String	No	Workflow name.
OwnerUin	String	No	Responsible person ID.
WorkflowParams	Array of ParamInfo	No	Workflow parameter array.
TriggerWorkflowSchedulerConfigurations	Array of WorkflowTriggerConfig	No	Unify scheduling parameters.
WorkflowDesc	String	No	Workflow description.
BundleId	String	No	BundleId item.
BundleInfo	String	No	BundleInfo item.
GeneralTaskParams	Array of WorkflowGeneralTaskParam	No	General parameter.

UpdateTriggerWorkflowResult

Update workflow result.

Used by actions: UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially.

Name	Type	Description
Status	Boolean	Update workflow result. Note: This field may return null, indicating that no valid values can be obtained.

UpdateWorkflowResult

Update workflow result.

Used by actions: UpdateWorkflow.

Name	Type	Description
Status	Boolean	Update Workflow Result

WorkflowDetail

Describes the workflow details.

Used by actions: GetWorkflow.

Name	Type	Description
WorkflowName	String	Workflow name.
OwnerUin	String	Owner ID.
CreateUserUin	String	Creator ID.
WorkflowType	String	Workflow type. Valid values: cycle or manual.
WorkflowParams	Array of ParamInfo	Workflow parameter array.
WorkflowSchedulerConfiguration	WorkflowSchedulerConfiguration	Unified scheduling parameter. .
WorkflowDesc	String	Workflow description.
Path	String	Workflow path.
BundleId	String	BundleId item.
BundleInfo	String	BundleInfo item. specifies the bundle information.

WorkflowFolder

Folder information.

Used by actions: ListWorkflowFolders.

Name	Type	Description
ProjectId	String	Project ID.
FolderId	String	Folder ID.
FolderPath	String	Specifies the absolute path of the folder.
CreateUserUin	String	Creator ID.

WorkflowFolderDetail

Folder details.

Used by actions: GetWorkflowFolder.

Name	Type	Description
ProjectId	String	Project ID.
FolderId	String	Folder ID.
FolderPath	String	Absolute path of the folder.
CreateUserUin	String	Creator ID. Note: This field may return null, indicating that no valid values can be obtained.
ParentFolderPath	String	Parent folder absolute path.
FolderName	String	Folder name.

WorkflowFolderPage

Paginate resource files.

Used by actions: ListWorkflowFolders.

Name	Type	Description
PageNumber	Integer	Data page number, equal to or greater than 1. Note: This field may return null, indicating that no valid values can be obtained.
PageSize	Integer	Specifies the number of data records displayed per page. value range: 10 to 200. Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of folders.
TotalPageNumber	Integer	Total pages
Items	Array of WorkflowFolder	Folder list.

WorkflowGeneralTaskParam

SQL parameter of the SPARK workflow.

Used by actions: CreateTriggerWorkflow, GetTriggerWorkflow, UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially.

Name	Type	Required	Description
Type	String	No	Common task parameter type, currently only support SPARK_SQL. Note: This field may return null, indicating that no valid values can be obtained.
Value	String	No	Common task parameter content. different parameters are separated by semicolons. Split. Note: This field may return null, indicating that no valid values can be obtained.

WorkflowInfo

Retrieves workflow list information item.

Used by actions: ListWorkflows.

Name	Type	Description
WorkflowId	String	Workflow ID.
WorkflowName	String	Workflow name.
WorkflowType	String	Workflow type: cycle or manual.
OwnerUin	String	Owner ID
CreateTime	String	Creation time.
ModifyTime	String	Last Modification Time
UpdateUserUin	String	Last updated user ID.
WorkflowDesc	String	Workflow description.
CreateUserUin	String	Creator ID.

WorkflowMaxPermission

Maximum permission type for user to recurse workflow folder.

Used by actions: GetMyWorkflowMaxPermission.

Name	Type	Description
PermissionType	String	Authorization permission type (CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE, currently only support CAN_MANAGE). Note: This field may return null, indicating that no valid values can be obtained.

WorkflowPermission

Authorization information for data development.

Used by actions: CreateWorkflowPermissions, ListWorkflowPermissions.

Name	Type	Required	Description
PermissionTargetType	String	Yes	Target type (user: user, role: role). Note: This field may return null, indicating that no valid values can be obtained.
PermissionTargetId	String	Yes	id array of the authorization target (userId/roleId). Note: This field may return null, indicating that no valid values can be obtained.
PermissionTypeList	Array of String	Yes	Authorization permission type array (CAN_VIEW/CAN_RUN/CAN_EDIT/CAN_MANAGE, currently only support CAN_MANAGE). Note: This field may return null, indicating that no valid values can be obtained.

WorkflowPermissionPage

Permission information for data development pagination.

Used by actions: ListWorkflowPermissions.

Name	Type	Description
PageNumber	Integer	Number of data pages, at least 1.
PageSize	Integer	Number of records per page. the minimum value is `10`. the maximum value is `200`.
TotalCount	Integer	Total number of authorized data.
TotalPageNumber	Integer	Total pages
Items	Array of WorkflowPermission	Authorization information list.

WorkflowSchedulerConfiguration

Unified workflow scheduling response parameters structure.

Used by actions: GetWorkflow.

Name	Type	Description
ScheduleTimeZone	String	Specifies the time zone.
CycleType	String	Period type. Supported types: ONEOFF_CYCLE: specifies a one-time cycle. YEAR_CYCLE: specifies the year cycle. MONTH_CYCLE: specifies the monthly cycle. WEEK_CYCLE: specifies the week cycle. DAY_CYCLE: specifies the day cycle. HOUR_CYCLE: specifies the hour cycle. MINUTE_CYCLE: specifies the minute cycle. CRONTAB_CYCLE: specifies the crontab expression type
SelfDepend	String	Self-Dependent. Valid values: parallel, serial, orderly. Default value: serial.
StartTime	String	Effective Start Time
EndTime	String	Effective End Time.
DependencyWorkflow	String	Workflow dependency. Valid values: yes or no.
ExecutionStartTime	String	Execution time. specifies the left-closed interval. example: 00:00.
ExecutionEndTime	String	Execution time right closed interval, for example: 23:59.
CrontabExpression	String	Cron expression
CalendarOpen	String	Whether calendar scheduling is enabled. Valid values: 1 (enabled), 0 (disabled).
CalendarName	String	Calendar name.
CalendarId	String	Calendar id.

WorkflowSchedulerConfigurationInfo

Workflow Unified Scheduling Parameter Input - Dependency Task Value Reference:

Used by actions: CreateWorkflow, UpdateWorkflow.

Name	Type	Required	Description
ScheduleTimeZone	String	Yes	Specifies the time zone.
CycleType	String	Yes	Period type. Supported types: ONEOFF_CYCLE: specifies a one-time cycle. YEAR_CYCLE: specifies the year cycle. MONTH_CYCLE: specifies the monthly cycle. WEEK_CYCLE: specifies the week cycle. DAY_CYCLE: specifies the day cycle. HOUR_CYCLE: specifies the hour cycle. MINUTE_CYCLE: specifies the minute cycle. CRONTAB_CYCLE: specifies the crontab expression type
SelfDepend	String	Yes	Self-Dependent. Valid values: parallel, serial, orderly. Default value: serial.
StartTime	String	Yes	Effective Start Time
EndTime	String	Yes	Effective End Time
CrontabExpression	String	Yes	Cron expression
DependencyWorkflow	String	No	Workflow dependency. Valid values: yes or no.
ModifyCycleValue	String	No	0: Do not modify 1: Reset the task's upstream dependency configuration to the default value
ClearLink	Boolean	No	The workflow contains cross-workflow dependencies and uses a cron expression for scheduling. If unified scheduling is saved, unsupported dependencies will be disconnected.
MainCyclicConfig	String	No	Takes effect when ModifyCycleValue = 1. Indicates the default modification of the upstream dependency time dimension. Valid values are: * 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
SubordinateCyclicConfig	String	No	Takes effect when ModifyCycleValue = 1. Indicates the default modification of the upstream dependency - instance scope. Valid values are: * 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
ExecutionStartTime	String	No	Execution time left closed interval, for example: 00:00. only required when the CycleType is MINUTE_CYCLE.
ExecutionEndTime	String	No	Execution time right closed interval, for example: 23:59. only required when the CycleType is MINUTE_CYCLE.
CalendarOpen	String	No	Whether calendar scheduling is enabled. Valid values: 1 (enabled), 0 (disabled).
CalendarId	String	No	Calendar id.

WorkflowTriggerConfig

Workflow scheduling configuration.

Used by actions: CreateTriggerWorkflow, GetTriggerWorkflow, ListOpsTriggerWorkflows, UpdateTriggerWorkflow, UpdateTriggerWorkflowPartially.

Name	Type	Required	Description
TriggerMode	String	Yes	Trigger mode. -Scheduled TRIGGER: TIME_TRIGGER. - CONTINUE_RUN: continuously RUN. -FILE_ARRIVAL. Note:. -In TIME_TRIGGER and CONTINUE_RUN mode, SchedulerStatus, SchedulerTimeZone, StartTime, EndTime, ConfigMode, CycleType, and CrontabExpression are required. -In FILE_ARRIVAL mode, FileArrivalPath, TriggerMinimumIntervalSecond, and TriggerWaitTimeSecond are required. Note: This field may return null, indicating that no valid values can be obtained.
ExtraInfo	String	No	Convert WorkflowTriggerConfig into Json format for reconciliation usage. Note: This field may return null, indicating that no valid values can be obtained.
ScheduleTimeZone	String	No	Scheduling time zone. Note: This field may return null, indicating that no valid values can be obtained.
StartTime	String	No	Schedule effective time. Note: This field may return null, indicating that no valid values can be obtained.
EndTime	String	No	Schedule end time Note: This field may return null, indicating that no valid values can be obtained.
ConfigMode	String	No	Setting method, general: COMMON, CRON EXPRESSION: CRON_EXPRESSION. Note: This field may return null, indicating that no valid values can be obtained.
CycleType	String	No	Period type: supported types are. ONEOFF_CYCLE: one-time. YEAR_CYCLE: year. MONTH_CYCLE: month. WEEK_CYCLE: week. DAY_CYCLE: day. HOUR_CYCLE: hr. MINUTE_CYCLE: minute. CRONTAB_CYCLE: crontab expression type. Note: This field may return null, indicating that no valid values can be obtained.
CrontabExpression	String	No	Cron expression Note: This field may return null, indicating that no valid values can be obtained.
TriggerId	String	No	triggerId, uuid Note: This field may return null, indicating that no valid values can be obtained.
FileArrivalPath	String	No	Listening path in the storage system under file arrival mode. Note: This field may return null, indicating that no valid values can be obtained.
TriggerMinimumIntervalSecond	Integer	No	File arrival mode triggers the shortest interval (unit: s). Note: This field may return null, indicating that no valid values can be obtained.
TriggerWaitTimeSecond	Integer	No	File arrival in mode. trigger waiting time (unit: seconds). Note: This field may return null, indicating that no valid values can be obtained.
SchedulerStatus	String	No	Trigger status. valid values: ACTIVE (start), PAUSED (suspend). Note: This field may return null, indicating that no valid values can be obtained.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud

AlarmGroup

AlarmMessage

AlarmQuietInterval

AlarmRuleData

AlarmRuleDetail

AlarmWayWebHook

AuthInfo

AuthorizePrivilegesRsp

AuthorizeResult

BackfillInstance

BackfillInstanceCollection

BatchOperationOpsDto

BindProject

BizStateEnumInfoBrief

BriefTask

BusinessMetadata

CatalogInfo

ChildDependencyConfigPage

CodeFile

CodeFileConfig

CodeFolderNode

CodePermissionsResultItem

CodeStudioFileActionResult

CodeStudioFolderActionResult

CodeStudioFolderResult

CodeStudioMaxPermission

ColumnInfo

CreateAlarmRuleData

CreateDataReplenishmentPlan

CreateFolderResult

CreateProjectResult

CreateResourceFileResult

CreateTaskBaseAttribute

CreateTaskConfiguration

CreateTaskFolderResult

CreateTaskResult

CreateTaskSchedulerConfiguration

CreateTriggerTaskBaseAttribute

CreateTriggerTaskConfiguration

CreateTriggerTaskSchedulerConfiguration

CreateTriggerWorkflowResult

CreateTriggerWorkflowRunResult

CreateWorkflowPermissionsResult

CreateWorkflowResult

DLCClusterInfo

DataBackfill

DataBackfillRange

DataSource

DataSourceFileUpload

DataSourceInfo

DataSourceResult

DataSourceStatus

DatabaseInfo

DatasourceRelationTaskInfo

DeleteAlarmRuleResult

DeleteFolderResult

DeleteResourceFileResult

DeleteTaskFolderResult

DeleteTaskResult

DeleteTriggerWorkflowResult

DeleteWorkflowPermission

DeleteWorkflowPermissionsResult

DeleteWorkflowResult

DependencyConfigPage

DependencyStrategyTask

DependencyTaskBrief

DependencyTriggerTaskBrief

EventListener

ExecutionActionBrief

ExecutorResourceGroupData

ExecutorResourceGroupInfo

ExploreAuthorizationObject

ExploreAuthorizationRecycleObject

ExploreAuthorizeSubject

ExploreFilePermissionsPage

ExploreFilePrivilegeItem

ExploreFileResource

Filter

GetResourcePrivilegeDetailRsp