Stopping a Job Instance¶
Function¶
This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.
URI¶
URI format
POST /v1/{project_id}/jobs/{job_name}/instances/{instance_id}/stop
Parameter description
¶ 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.
instance_id
Yes
Long
Job instance ID. For details about how to obtain it, see Viewing a Job Instance List.
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
workspace | No | String | Workspace ID.
|
Response Parameters¶
None.
Example Request¶
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_batch/instances/34765/stop
Example Response¶
Success response
HTTP status code 204
Failure response
HTTP status code 400
{ "error_code":"DLF.0137", "error_msg":"Job instance does not exist." }