This topic describes how to create and manage XXL-JOB jobs on the Task Management page.
Create a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management. On the page that appears, click Create Task. In the Basic configuration step, configure relevant job information, and click Next step.
Category
Parameter
Description
Default value
Basic configuration
Task Name
The name of the job, which must be unique within an application.
None
Task Description
The description of the job.
None
Associated Applications
The associated application.
None
Job Type
The job type. Valid values: BEAN, Dify, GLUE (Java), GLUE (Python), GLUE (PHP), GLUE (Node.js), and GLUE(PowerShell).
BEAN
JobHandler Name
The name of the job handler that corresponds to the
jobHandlerdeclared by the@Xxljobannotation on the executor.None
Routing Policy
The routing policy. Valid values: Polling, Random, First, Last, Least Frequently Used, Recently Not Used, Consistent Hashing, and Multipart Broadcast.
Polling
Blocked Job Processing Policy
The client-level throttling policy. Valid values: Serial Execution, Discard Subsequent Scheduling, and Overwrite Previous Scheduling.
Serial Execution
Priority
The job priority. Valid values: Low, Medium, High, and Very high.
Medium
Input
The parameters of the job. The value can be up to 2,000 bytes in length.
None
Advanced configuration
Task failure retries
The number of automatic retries if the job fails.
0
Task failure retry interval
The interval between two consecutive retries. Unit: seconds.
30
Task Concurrency
The maximum number of job instances that can concurrently run. A value of 1 specifies that concurrent execution is not allowed. If the concurrency limit is reached, the expected scheduling is skipped.
1
Child Job ID
The ID of the subtask.
NoteAfter a job is successfully executed, its subtasks are triggered. You can enter multiple subtask IDs that are separated by commas (,).
None
In the Timing Configuration step, configure the time-based settings and advanced settings, and click Next step.
Parameter
Description
Default value
Time Type
The time type. Valid values: none, cron, api, fixed_rate, fixed_delay, and one_time.
cron
cron expression
cron expressions vary with time types. Valid values:
none: No expression is required.
cron: Enter a Cron expression that is accurate to seconds.
fixed_rate: Specify a fixed execution interval. Unit: seconds.
fixed_delay: Specify a fixed latency. Unit: seconds. For example, the next job is scheduled N seconds after the previous job is executed. In this example, N is specified by fixed_delay.
api: The job is scheduled by calling an API operation.
one_time: Specify the time when a job is scheduled. After the job is executed, it is destroyed. The scheduling time is in the format of yyyy-MM-dd HH:mm:ss, such as 2024-10-10 12:12:20.
None
Data Time Offset
The offset between the time data is processed and the time the job is scheduled. You can obtain the offset value from the context when the job is scheduled.
None
Time Zone
The time zone. This parameter is used for cron expressions.
Time zone of the current region
Calendar
The calendar. You can import a custom calendar and configure a scheduling time based on the calendar. For example, you can configure the job to run only on business days.
Daily Schedule
Effective time
The time when the scheduling settings take effect.
Effective immediately
In the Notification Configuration step, configure alert settings and alert contacts, and click Complete.
Parameter
Description
Default value
Timeout alarm
Specifies whether to send an alert if the job times out.
Open
Timeout
The timeout period. Unit: seconds. Specify a value based on your business requirements.
7200
Timeout termination
Specifies whether to automatically stop the job if the job times out. This prevents the job timeout from affecting the next scheduling.
Close
Notification of success
Specifies whether to notify the contacts if the job is successfully run. We recommend that you enable this feature for important jobs that run on a daily basis.
Close
Failure alarm
Specifies whether to send an alert if the job fails.
Open
Number of consecutive failures
The number of consecutive job failures before an alert can be sent.
1
No Machine Alarm Available
Specifies whether to send an alert if no executor is available when the job is scheduled to run.
Open
Notification Method
The alert notification method. Valid values: SMS, webhook, Mail, and Telephone.
None
Notification Object
The contacts. The contacts added in CloudMonitor are displayed. You must configure alert contacts in the CloudMonitor console first. Make sure that the information of the alert contacts is verified.
None
If you use webhooks to send alerts to DingTalk, WeCom, or Lark users, alerts are sent over the Internet. Therefore, you must associate an Internet NAT gateway with the virtual private cloud (VPC) in which your XXL-JOB instance resides.
Modify the configuration of a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click Edit in the Operation column of the desired job. In the Edit Task panel, modify the settings in the Basic configuration, Timing Configuration, and Notification Configuration steps, and click Complete.
Delete a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click More in the Operation column of the job. In the list that appears, select Delete. In the Delete message, click Delete.
Import a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click Import Task. In the Import Task dialog box, select Cover or Skip for Same task, specify Automatic CreationApp, click Select File to upload the file to be imported, and then click OK.
Export a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click Export Tasks. In the Export Tasks dialog box, select the application name of the job to be exported and click OK.
Enable multiple jobs at a time
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Select the jobs that you want to enable and click BatchEnableTask. In the BatchEnableTask dialog box, click OK.
Disable multiple jobs at a time
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Select the jobs that you want to disable and click BatchDisableTask. In the BatchDisableTask dialog box, click OK.
Delete multiple jobs at a time
Note that a job cannot be recovered after it is deleted.
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Select the jobs that you want to delete and click BatchDeleteTask. In the BatchDeleteTask dialog box, click OK.
Run a job once
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click Run once in the Operation column of the job. In the Perform tasks manually dialog box, specify Designated machine and Job Parameters, and click OK.
Clone a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click More in the Operation column of the job. In the list that appears, select Copy. In the Copy Tasks panel, configure parameters in the Basic configuration, Timing Configuration, and Notification Configuration steps, and click Complete.
Disable a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click More in the Operation column of the job. In the list that appears, select Disable. In the Disable message, click Disable.
View scheduling records
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click More in the Operation column of the job. In the list that appears, select Scheduling Records. View the scheduling execution records of the job.
Rerun a job
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click More in the Operation column of the job. In the list that appears, select Rebrush task. In the Rebrush task panel, specify the Start and end date and Data Time, and click OK.
Designate a machine
Log on to the MSE console, and select a region in the top navigation bar.
In the left-side navigation pane, choose .
Click the ID of the desired instance. In the left-side navigation pane, click Task Management.
Click More in the Operation column of the job. In the list that appears, select Designated machine. In the Designated machine panel, select Address or Label from the Specified Type drop-down list, specify a machine, and then click OK.
NoteMachine Transfer: After you turn on this switch, the job can be scheduled to a non-specified machine after all specified machines are offline.