Connect HTTP applications to XXL-JOB

Scenarios

Benefits

• Non-intrusive connection: Connect to task scheduling through the HTTP protocol without deploying an agent in your business system.

• Cross-platform compatibility: Supports any service that provides an HTTP interface, regardless of the programming language or framework.

• Flexible deployment: Supports Kubernetes and non-Kubernetes environments, including traditional ECS instances and physical servers.

• Simple configuration: Connect the executor by entering the HTTP service endpoint.

How it works

Prerequisites

Before you begin, make sure that you have:

• The required Resource Access Management (RAM) permissions for XXL-JOB

• An XXL-JOB instance

Step 1: Create an HTTP application

1. Log on to the XXL-JOB console and select a region in the top menu bar.

2. Click the target instance to open its details page.

3. In the left-side navigation pane, choose Application Management and click Create Application.

4. In the Create Application dialog box, select HTTP Application and configure the following fields:

   Field	Required	Description
   AppName	Yes	Unique identifier for executor registration. 1--64 bytes. Supports letters, digits, underscores (_), and hyphens (-). Must start with a letter or digit.
   Name	Yes	Descriptive name for the application. 1--64 characters.
   AccessToken	Yes	Authentication token for executor registration. 6--32 characters. Supports letters and digits. The system auto-generates a value, which you can modify.

5. Click OK.

The application appears in the application list with 0 executors. Proceed to Step 2 to connect an executor before running tasks.

Step 2: Connect an executor

Choose the connection method based on your deployment environment:

• Kubernetes environment: Connect to a Kubernetes Service

• Non-Kubernetes environment: Connect with a domain name

Step 3: Create an HTTP task

1. In the left-side navigation pane, choose Task Management and click Create Task.

2. Configure the basic task settings:

   Field	Required	Description
   Task Name	Yes	A name for the task, such as test-http-task.
   Associated Application	Yes	The HTTP application created in Step 1.
   Task Type	Yes	Select HTTP.

3. Configure the HTTP request:

   Field	Required	Description
   API Path	Yes	The request path. Must start with /, such as / or /v1/hello.
   Request Method	Yes	GET, POST, PUT, DELETE, or another HTTP method.
   Timeout	Yes	Request timeout in seconds, such as 30.

4. (Optional) Add request details:

   Field	Description
   Header	HTTP request headers, such as Content-Type: application/json.
   Query	URL query parameters, such as param1=value1&param2=value2.
   Body	Request body for POST or PUT requests.

5. Define success criteria: (Optional) Configure Success result parsing to extract values from the response using JSONPath or regular expressions.

   Method	Description	Example
   HTTP status code	Match a specific status code.	200
   Response body JSON	Evaluate a JSONPath expression against the response body.	$.code equals 200
   Response body	Check whether the response body contains a specific string.	"success"

6. Configure failure retry:

   Field	Description	Example
   Task failure retries	Number of retry attempts on failure.	3
   Task failure retry interval	Wait time between retries, in seconds.	30

7. Configure the schedule:

   Field	Description
   Time Type	cron or Fixed Frequency.
   Cron Expression	A cron expression defining the schedule. See the reference table below.
   Time Zone	The time zone for schedule evaluation.
   Calendar	Daily scheduling or a specific calendar.
   Start Time	Effective immediately or at a specified time.

   Common cron expressions

   Expression	Schedule
   0 0 12 * * ?	Every day at 12:00 PM
   0 0/30 * * * ?	Every 30 minutes
   0 0 9 * * ?	Every day at 9:00 AM
   0 0 0 * * ?	Every day at midnight
   0 0 9 ? * MON-FRI	Every weekday at 9:00 AM

8. (Optional) Configure notifications:

   Field	Description
   Success notification	Notification method for successful executions.
   Failure alarm	Alarm configuration for failed executions.
   Notification Method	Text message, webhook, email, phone call, or another method.
   Notification Recipient	Contacts to receive notifications.

9. Click Finish.

The task appears in the task list with a status of Enabled.

Step 4: Test the task

1. On the Task Management page, find the task and click Run Once.

2. In the confirmation dialog box, click OK to trigger execution.

3. In the left-side navigation pane, choose Task Instances to view execution records. Each record shows the execution ID, status, duration, and execution node. A status of Succeeded confirms the task completed correctly.

4. Click an execution ID or click Log to inspect the full HTTP exchange: request method, URL, headers, body, response status code, response headers, and response body.

5. (Optional) In the left-side navigation pane, choose Event Center to view the complete execution flow: Scheduled, Running, and Succeeded or Failed.

FAQ