HTTP tasks (Serverless)

GET

To use the GET request method, you can add the configuration to the client and then create the task in the console.

Step 1: Basic configuration

1. Add the GET method configuration in the client.

   The following code shows an example configuration. For more information about how to connect a client to SchedulerX, see Connect a Spring Boot application to SchedulerX.

   @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;
   }

2. Create an HTTP task in the console.

   The following figure shows the required configurations for an HTTP task that uses the GET method. For more information about how to create a scheduling task, see Create a scheduling task.

   The following table describes the parameters for a Serverless HTTP task.

   Parameter	Description
   Task name	The name of the task.
   Description	A brief description of the task to make it easier to search for later.
   Application ID	Select the target application.
   Task type	The type of the task. Supported types include Java, Shell, Python, Go, http, xxljob, and DataWorks. If you select Shell, Python, or Go, a script editor appears. In this example, select http.
   Full URL	Enter the full URL, including http://.
   Execution Mode	In this example, select GET.
   Response parsing mode	Select a response parsing mode. The following modes are supported: HTTP response code The response is based on the HTTP response code. You must set a standard HTTP request response code. Custom JSON Response validation key and value. The server-side expects the HTTP request result to be in JSON format. It verifies the result based on the specified key and value. { "code": 200, "data": "true", "message": "", "requestId": "446655068791923614103381232971", "success": true } In the preceding sample code, you can check if the key is `Success` and the value is `true`, or if the code is `200`. Custom string The task execution is considered successful if the returned string exactly matches the custom string.
   Return check key	This applies only to responses in JSON format. This is the key to check for a successful response.
   Return check value	This applies only to responses in JSON format. This is the value to check for a successful response.
   Execution timeout (seconds)	The maximum timeout is 30 seconds for the Basic Edition and 120 seconds for the Professional Edition. An error is reported if a timeout occurs.
   Cookie	For example, key1=val1;key2=val2. Separate multiple values with a semicolon (;). The maximum length is 300 bytes.

3. After the task is created, click Run Once in the Actions column on the Task Management page.

   The following result indicates that the task was successfully executed.

Step 2: Configure time-based scheduling

1. In the Time-based Scheduling step, set the time-based and advanced configuration parameters, and then click Next.

   

   The scheduled parameters are as follows:

   Configuration Name	Significance
   Time type	none: The task is typically triggered by a workflow instead of being scheduled. cron: The task is scheduled using a cron expression. api: An API call triggers the task. fixed_rate: A fixed frequency. second_delay: The task is scheduled to run after a fixed delay in seconds. onetime: The task runs only once.
   cron expression (This option is available only when the Time type is set to cron.)	Enter a cron expression. You can enter an expression that follows the cron syntax, or use a tool to generate and validate one.
   Fixed frequency (only available when the Time Type is set to fixed_rate)	Enter a fixed frequency in seconds. Only values greater than 60 are supported. For example, a value of 200 means the task is scheduled every 200 s.
   Fixed delay (Only available when Time type is set to second_delay)	Enter a fixed delay in seconds. The value must be between 1 and 60. For example, a value of 5 means the task is scheduled with a 5 second delay.

   If you set Time type to cron, you can configure advanced settings. The following table describes the advanced configuration parameters.

   Configuration Name	Description
   Time offset	The offset of the data timestamp relative to the scheduled time. You can get this value from the context during scheduling.
   Time zone	Select a time zone as needed. You can select from common countries or regions, or use the standard GMT format.

Step 3: Configure alerts

HTTP tasks support alerts for errors. You can set alert conditions when you create a task to receive notifications for issues such as timeouts or unexpected return values.

1. In the Alert Configuration step, set the alert parameters and contacts, and click Finish.

   

POST

To use the POST request method, you can add the configuration to the client and then create the task in the console.

Step 1: Basic configuration

1. Add the POST configuration in the client.

   The following code shows the configuration for the POST method. For more information about how to connect a client to SchedulerX, see Connect a Spring Boot application to SchedulerX.

   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;
   }

2. Create an HTTP task in the console.

   The following figure shows the required configurations for an HTTP task. For more information about how to create a scheduling task, see Create a scheduling task.

   Parameter	Description
   Full URL	Enter the full URL, including http://.
   Response parsing mode	Select a response parsing mode. The following modes are supported: HTTP response code The response is based on the HTTP response code. You must set a standard HTTP request response code. Custom JSON Response validation key and value. The server-side expects the HTTP request result to be in JSON format. It verifies the result based on the specified key and value. { "code": 200, "data": "true", "message": "", "requestId": "446655068791923614103381232971", "success": true } In the preceding sample code, you can check if the key is `Success` and the value is `true`, or if the code is `200`. Custom string The task execution is considered successful if the returned string exactly matches the custom string.
   Return check key and Return check value	The server-side expects the HTTP request result to be in JSON format. It verifies the result based on the specified key and value. { "code": 200, "data": "true", "message": "", "requestId": "446655068791923614103381232971", "success": true } In the preceding sample code, you can check if the key is `Success` and the value is `true`, or if the code is `200`.
   Execution timeout (seconds)	The maximum timeout is 30 seconds. An error is reported if a timeout occurs.
   Parameters	The POST form parameters. For example, key1=val1;key2=val2.

Step 2: Configure time-based scheduling

In the Time-based Scheduling step, set the time-based and advanced configuration parameters, and then click Next.

Step 3: Configure alerts

HTTP tasks support alerts for errors. You can set alert conditions when you create a task to receive notifications for issues such as timeouts or unexpected return values.

1. In the Alert Configuration step, you can set the alert parameters and contacts, and then click Finish.