Suspend Job

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameSuspend Job (Asynchronous API)
Description

Suspends a running job – the VM is powered off and remains in the NodeSuspended state

Allowed Role(s)WM_USER
MethodPUT
URI

v1/jobs/jobId?action=suspend

cloudcenter-ccm-backend/api/v1/jobs/jobId?action=suspend

Sample Request
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/920?action=suspend"
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/jobs/920?action=suspend"
Release

Introduced in CloudCenter 3.x

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • This API returns a reference to a tracking ID that can be used to retrieve  the status of the stop operation.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: update.jobs.jobId
actionparam: action=suspend

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Response

The API suspends 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 the Deployment and VM States section for the relevant release to view 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
© 2017-2019 Cisco Systems, Inc. All rights reserved