ExecuteJob - SchedulerX - Alibaba Cloud Documentation Center

Triggers a job to immediately run once.

Operation description

Note The combination of the JobID and ScheduleTime parameters serves as a unique index. Therefore, after the ExecuteJob operation is called to run a job once, a sleep for one second is required before the ExecuteJob operation is called to run the job again. Otherwise, the job may fail.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ManageSchedulerxJobTrigger	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobId	long	Yes	The job ID. You can obtain the job ID on the Task Management page in the SchedulerX console.	92583
InstanceParameters	string	Yes	The parameters that are passed to trigger the job to run. The input value can be a random string. The parameters that are passed are obtained by calling the `context.getInstanceParameters()` class in the `processor` code. The parameters are different from custom parameters for creating jobs.	test
Namespace	string	Yes	The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
GroupId	string	Yes	The application ID. You can obtain the application ID on the Application Management page in the SchedulerX console.	testSchedulerx.defaultGroup
RegionId	string	Yes	The region ID.	cn-hangzhou
CheckJobStatus	boolean	No	Specifies whether to check the job status. Valid values: -true: The job can be run only if the job is enabled. -false: The job can be run even if the job is disabled.	true
DesignateType	integer	No	The type of the designated machine. Valid values: -1: worker. -2: label.	1
Worker	string	No	The worker address of the application. To query the worker address, call the GetWokerList operation.	xxxxxxx@127.0.0.1:222
Label	string	No	The label of the worker.	gray

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code.	200
Message	string	The error message that is returned only if the corresponding error occurs.	groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
RequestId	string	The request ID.	4F68ABED-AC31-4412-9297-D9A8F0401108****
Success	boolean	Indicates whether the request was successful. Valid values: `true` `false`	true
Data	object	The ID of the job instance that is returned if the request is successful.
JobInstanceId	long	The job instance ID.	11111111

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108****",
  "Success": true,
  "Data": {
    "JobInstanceId": 11111111
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-21	The response structure of the API has changed	View Change Details
2022-12-26	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-12-30	The request parameters of the API has changed	View Change Details
2021-12-20	The request parameters of the API has changed	View Change Details