Executing a Job Immediately
Function
This API is used to execute a job immediately and check whether the job can be executed successfully.
URI
- Parameter description
Table 1 URI parameter Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
job_name
Yes
String
Job name.
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workspace |
No |
String |
Workspace ID.
|
Parameter
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
jobParams |
No |
List<JobParam> |
Parameter for starting the job. |
JobParam data structure description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Name of the parameter. It cannot exceed 64 characters. |
value |
Yes |
String |
Value of the parameter. It cannot exceed 1024 characters. |
Response
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instanceId |
Yes |
Long |
Job instance ID. |
Example
Execute the myJob job once.
- Request
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/run-immediate { "jobParams":[ { "name":"aaa", "value":"111" }, { "name":"bbb", "value":"222" } ] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.