SchedulerX:HTTP jobs

GET

1. Deploy an accessible HTTP service.

   • If an accessible HTTP service is already deployed, perform Step 2 to create an HTTP job in the Microservices Engine (MSE) console. You must prepare the URL of the HTTP service, the request method (GET or POST), and other configuration information.

   • If no accessible HTTP service is deployed, deploy one by calling Java-based HTTP interface. Sample code:

     @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. Log on to the MSE console, and create an HTTP job on the SchedulerX Version page.

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

   

The following table shows the parameters for a serverless HTTP job and an agent HTTP job.

POST

1. Deploy an accessible HTTP service.

   • If an accessible HTTP service is already deployed, perform Step 2 to create an HTTP job in the MSE console. You must prepare the URL of the HTTP service, the request method (GET or POST), and other configuration information.

   • If no accessible HTTP service is deployed, deploy one by calling Java-based HTTP interface. Sample code:

     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. Log on to the MSE console, and create an HTTP job on the SchedulerX Version page.

   The following figure shows the configurations of the HTTP job that uses the POST method. For more information about how to create a scheduling job, see Create a job.

   The following table shows the parameters for a serverless HTTP job and an agent HTTP job.

   Note

   The parameters for the Serverless and Agent modes in the MSE console are the same.

   Parameter	Description
   Task name	The custom name of the job.
   Description	The job description. To facilitate subsequent queries, we recommend that you use simple words.
   Application ID	The ID of the application to which the job belongs. Select a value from the drop-down list.
   Task type	The job type. In this example, select Http.
   Full url	Enter a complete URL that starts with http or https.
   Request method	The request method. Select GET or POST.
   Response analysis mode	The mode in which the response is parsed. Valid values: HTTP response code If you select this mode, HTTP response code is returned. You must configure standard HTTP response code. Custom JSON If you select this mode, you must configure the Return check key and Return check value parameters. By default, an HTTP response in the JSON format is returned from the server. The system checks whether the request is successful based on the return check key and value that you specified. { "code": 200, "data": "true", "message": "", "requestId": "446655068791923614103381232971", "success": true } In the preceding sample code, the system determines that the request is successful if the value of the success key is true or the value of the code key is 200. Custom string If you select this mode, the system determines that the request is successful if the return string matches the custom string that you specified.
   When you set the Response analysis mode parameter to HTTP response code:
   HTTP response code	The HTTP response code. Default value: 200.
   When you set the Response analysis mode parameter to Custom JSON:
   Return check key	The return key that is used to determine whether a request is successful. Only responses in the JSON format are supported.
   Return check value	The return value that is used to determine whether a request is successful. Only responses in the JSON format are supported.
   When you set the Response analysis mode parameter to Custom string:
   Custom string	The custom string that you specify.
   Execution timeout	The execution timeout period. If you set Execution way to serverless, the maximum timeout period is 30s for Basic edition and 120s for the Professional edition. If you set Execution way to agent, no limit is imposed on the timeout period.
   ContentType	The data type of the request when you set the Request method parameter to POST. Valid values: application/x-www-form-urlencoded application/json
   Post parameters	The POST form parameters when you set the Request method parameter to POST. Example when you set the ContentType parameter to application/x-www-form-urlencoded: key1=value&key2=value2 Example when you set the ContentType parameter to application/json: {"key1":"val1","key2":"val2"}
   cookie	The key-value pairs. Example: key1=val1;key2=val2. Separate multiple key-value pairs with semicolons (;). The maximum length of the value is 300 bytes.
   Execution way	serverless: The server initiates requests. A URL that can be accessed over the Internet is required. agent: The agent initiates requests. You must install a SchedulerX agent of V1.8.2 or later to initiate requests. You can configure an internal URL.
   Advanced Configuration
   Task failure retry count	The number of retries after the job failed to run. Default value: 0.
   Task failure retry interval	The retry interval between failed jobs. Default value: 30. Unit: seconds.
   Task concurrency	The maximum number of instances allowed to run concurrently for the same job. The value 1 indicates that only one job instance is allowed at a time. If the number of instances that concurrently run for a scheduling job exceeds the specified value, the scheduling job is skipped.
   Cleaning strategy	The strategy used to clear historical records that are generated during job execution. Default value: Keep last N entries. N is specified by the value of the Retained Number parameter. Valid values: Keep last N entries Keep last N entries by status
   Retained Number	The number of historical records to be retained after job execution. Default value: 300.