Stop Job

Details

API Details
NameStop Job
Description

Stop (terminate) a running job. This API returns a reference to a tracking ID that can be used to retrieve the status of the stop operation.

MethodPUT
URI/v1/jobs/jobId?action=stop
CloudCenter Release

CloudCenter 3.x and 4.x

NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.jobs.jobId
actionparam: action=stop

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/920?action=stop"

Response

The response to this CURL request would be a reference to a resource that provides latest status of the operation:

curl -k -X PUT -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/operationStatus/85614908-f9f9-4553-8d5e-56cda496f612" 

 

The API would start bringing down the VMs launched for this job..

{ 
 "id": "85614908-f9f9-4553-8d5e-56cda496f612", 
 "resource": "https://<HOST>:<PORT>/v1/operationStatus/85614908-f9f9-4553-8d5e-56cda496f612" 
}

 

Use the Get Operation Status to view the current status and continue trying until you eventually receive the following response once the job is successfully stopped:

 {"status":"SUCCESS","resource":"https://<HOST>:<PORT>/v1/jobs/{jobId}"} 

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
status
  • Description: Status of the operation. See Deployment and VM States for a list of all job operations.
  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe operation has been submitted
    RUNNINGThe operation is currently in progress
    SUCCESSThe operation succeeded
    FAILThe operation failed