AlarmGroup
Alarm rule recipient configuration.
Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, 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, ListOpsAlarmRules, 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, ListOpsAlarmRules, 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. |
AlarmWayWebHook
Alarm channel specifies the webhook url configuration for wecom group, dingtalk group, or lark group.
Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, 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. |
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. |
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. |
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: 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 |
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. |
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. |
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 |
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. |
CreateTaskResult
Create task return format.
Used by actions: CreateTask.
| 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. |
| ScheduleRunType | String | No | Scheduling type: 0 for normal scheduling, 1 for dry-run scheduling. Default is 0. |
| 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 |
| RunPriority | String | No | Task scheduling priority. Valid values: 4 (high), 5 (medium), 6 (low). Default: 6. |
| RetryWait | String | No | Retry Policy: Retry Wait Time (in minutes): Default 5 |
| MaxRetryAttempts | String | No | Retry Policy: maximum attempts. Default: 4. |
| ExecutionTTL | String | No | Timeout Handling Policy: Execution Timeout (in minutes), default: -1 |
| WaitExecutionTotalTTL | String | No | Timeout Handling Policy: Wait Duration Timeout (in minutes), default: -1 |
| 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. |
CreateWorkflowResult
Create workflow result.
Used by actions: CreateWorkflow.
| Name | Type | Description |
|---|---|---|
| WorkflowId | String | Workflow id after successful creation. |
DataBackfillRange
Backfill plan date range.
Used by actions: CreateDataBackfillPlan.
| 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. |
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 |
DeleteTaskResult
Deletion result of a data development task.
Used by actions: DeleteTask.
| Name | Type | Description |
|---|---|---|
| Status | Boolean | Deletion status. true indicates success. false indicates failure. |
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.
| 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.
| 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 |
EventListener
Event listener.
Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask.
| 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 |
InTaskParameter
Parameter passing - reference parameter.
Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask.
| 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. |
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.
| 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. |
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. |
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. |
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. |
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. |
ModifyAlarmRuleResult
Describes the response of updating an Alarm rule.
Used by actions: UpdateOpsAlarmRule.
| Name | Type | Description |
|---|---|---|
| Status | Boolean | Whether update succeeded |
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, ListOpsAlarmRules, 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. |
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: KillTaskInstancesAsync, PauseOpsTasksAsync, RerunTaskInstancesAsync, 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 |
OutTaskParameter
Parameter passing - output parameter.
Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask.
| Name | Type | Required | Description |
|---|---|---|---|
| ParamKey | String | Yes | Parameter name. |
| ParamValue | String | Yes | Parameter definition. |
ParamInfo
Parameters
Used by actions: CreateTask, CreateWorkflow, GetOpsTask, GetTask, GetWorkflow, UpdateTask, 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 |
ProjectInstanceStatisticsAlarmInfo
Alarm rule project fluctuation rate Alarm configuration information.
Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, 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. |
ReconciliationStrategyInfo
Offline integration reconciliation Alarm rule.
Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, 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. |
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. |
ResourceFolderPage
Paginate resource folders.
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 |
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: 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 |
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 |
SubmitTaskResult
Submits the result of a data development task.
Used by actions: SubmitTask.
| Name | Type | Description |
|---|---|---|
| VersionId | String | Generated task version ID. |
| Status | Boolean | Submission status. |
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 |
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.
| Name | Type | Description |
|---|---|---|
| CodeInfo | String | Code content. |
| CodeFileSize | String | Code file size. unit: KB. |
TaskConfiguration
Task configuration information.
Used by actions: GetOpsTask, GetTask, UpdateTask.
| 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, separated by;, obtained through DescribeDataSourceWithoutInfo. Note: This field may return null, indicating that no valid values can be obtained. |
| SourceServiceType | String | No | Data source type. use semicolon to separate. 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. use semicolons to separate. need to pass through DescribeDataSourceWithoutInfo to obtain. Note: This field may return null, indicating that no valid values can be obtained. |
| TargetServiceId | String | No | TargetTarget data source ID, separated by semicolons. 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. uses ; for separation. needs to pass through DescribeDataSourceWithoutInfo for retrieval. Note: This field may return null, indicating that no valid values can be obtained. |
| TargetServiceName | String | No | Target data source name. use semicolon to separate. 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, GetOpsTask, GetTask, UpdateTask.
| 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, GetOpsTask, GetTask, UpdateTask.
| Name | Type | Required | Description |
|---|---|---|---|
| ParamKey | String | Yes | Parameter name. |
| ParamValue | String | Yes | Parameter value. |
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.
| 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. |
| ScheduleRunType | Integer | No | Scheduling type: 0 for normal scheduling, 1 for dry-run scheduling. |
| 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 | SpecSpecifies the downstream dependency array. |
| EventListenerList | Array of EventListener | No | Array of Events |
| RunPriority | Integer | No | Task scheduling priority. valid values: 4 (high), 5 (medium), 6 (low). default: 6. |
| RetryWait | Integer | No | Retry policy. retry wait time in minutes. default: 5. |
| MaxRetryAttempts | Integer | No | Specifies the maximum attempts of the retry policy. default: 4. |
| ExecutionTTL | Integer | No | Timeout Handling Policy: Execution Timeout (in minutes), default: -1 |
| WaitExecutionTotalTTL | String | No | Timeout Handling Policy: Wait Duration Timeout (in minutes), default: -1 |
| 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. |
TaskSchedulingParameter
Scheduling variable parameter.
Used by actions: CreateTask, GetOpsTask, GetTask, UpdateTask.
| 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. |
TimeOutStrategyInfo
Alarm timeout configuration rule information.
Used by actions: CreateOpsAlarmRule, GetOpsAlarmRule, ListOpsAlarmRules, 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. |
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 |
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. |
UpdateTaskResult
Update task response parameters structure.
Used by actions: UpdateTask.
| 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. |
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. |
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. |
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. |
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:
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: 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. |
Feedback