HTTP jobs

Choose an execution mode

Prerequisites

Before you begin, make sure that you have:

• A deployed HTTP service with a URL accessible from the Internet (serverless mode) or from the agent host (agent mode)

• (Agent mode only) A deployed SchedulerX agent (version later than 1.8.2). See Deploy the SchedulerX agent.

Create an HTTP job

Creating an HTTP job involves three steps: configure basic settings, set up scheduling, and configure notifications.

@GET
@Path("hi")
@Produces(MediaType.APPLICATION_JSON)
public RestResult hi(@QueryParam("user") String user) {
    TestVo vo = new TestVo();
    vo.setName(user);
    RestResult result = new RestResult();
    result.setCode(200);
    result.setData(vo);
    return result;
}

import com.alibaba.schedulerx.common.constants.CommonConstants;

@POST
@Path("createUser")
@Produces(MediaType.APPLICATION_JSON)
public RestResult createUser(@FormParam("userId") String userId,
        @FormParam("userName") String userName) {
    TestVo vo = new TestVo();
    System.out.println("userId=" + userId + ", userName=" + userName);
    vo.setName(userName);
    RestResult result = new RestResult();
    result.setCode(200);
    result.setData(vo);
    return result;
}

{
  "code": 200,
  "data": "true",
  "message": "",
  "requestId": "446655068791923614103381232971",
  "success": true
}

Set up scheduling

In the Timing configuration step, set the scheduling parameters and click Next Step.

Scheduling parameters

Parameter	Description
Time type	The scheduling method. Options: none (no scheduling; typically used with workflows), cron (cron expression), api (API-triggered), fixed_rate (fixed interval), second_delay (second-level delay), one_time (single execution).
cron expression	A cron expression defining the schedule. Available when Time type is cron. Use the built-in tool to generate a valid expression.
Fixed frequency	The interval in seconds between runs. Must be greater than 60. Available when Time type is fixed_rate.
Fixed delay	The delay in seconds between runs. Valid values: 1 to 60. Available when Time type is second_delay.
Scheduling time	The date and time for a one-time execution. Available when Time type is one_time.

Advanced scheduling parameters

Parameter	Description
Time offset	The offset between the data processing time and the job scheduling time. Retrieve this value from the scheduling context at runtime.
Time zone	The time zone for scheduling. Select a country/region time zone or a GMT offset.
Calendar	The calendar that determines when the job runs. Options: Daily scheduling, Specify calendar (choose Financial day or Workday).
Effective time	When the schedule takes effect. Options: Effective immediately, Start Time (select a specific date and time).

Retrieve job metadata from HTTP headers

SchedulerX passes job metadata in HTTP request headers. To read this metadata in your HTTP service, add the following Maven dependency:

<dependency>
    <groupId>com.aliyun.schedulerx</groupId>
    <artifactId>schedulerx2-common</artifactId>
    <version>1.6.0</version>
</dependency>

The following GET endpoint example reads the job ID and job name from the request headers:

import com.alibaba.schedulerx.common.constants.CommonConstants;

@GET
@Path("hi")
@Produces(MediaType.APPLICATION_JSON)
public RestResult hi(@QueryParam("user") String user,
        @HeaderParam(CommonConstants.JOB_ID_HEADER) String jobId,
        @HeaderParam(CommonConstants.JOB_NAME_HEADER) String jobName) {
    TestVo vo = new TestVo();
    vo.setName("armon");
    // Decode URL-encoded job name (required for non-ASCII characters)
    String decodedJobName = URLDecoder.decode(jobName, "utf-8");
    System.out.println("user=" + user + ", jobId=" + jobId + ", jobName=" + decodedJobName);
    RestResult result = new RestResult();
    result.setCode(200);
    result.setData(vo);
    return result;
}

Verify the result

After a job runs, check the execution list for the result.

If a job fails, click Details to view the failure reason. Common failure scenarios include:

• Return value mismatch: The actual response does not match the expected value configured in the response analysis mode.

• Execution timeout: The job exceeded the configured timeout period.