Reconfigure Running Job

Details

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

Reconfigures a running job

Allowed Role(s)WM_USER
MethodPUT
URI

v1/jobs/jobId?action=reconfigure

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

Sample Request
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://10.10.100.10/v1/jobs/934?action=reconfigure"
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://10.10.100.10/cloudcenter-ccm-backend/api/v1/jobs/934?action=reconfigure"
Release
  • Introduced in CloudCenter 3.x
  • Modified in CloudCenter 3.2.6.8 to ensure asynchronous job reconfiguration

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.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: put.jobs.jobId
actionparam: action=reconfigure

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

Not applicable

Sample Response

{
    "id": "2783306d-b670-440b-a51f-6dbfb16d3003",
    "resource": "https://10.10.100.10/v1/operationStatus/2783306d-b670-440b-a51f-6dbfb16d3003",
    "perms": [],
    "msg": "Reconfiguring the job."
} 

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 reconfigured:

{
    "status": "SUCCESS",
    "msg": "Job was reconfigured successfully.",
    "resource": "https://10.10.100.10/v1/jobs/397",
    "additionalParameters": []
}

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
 perms (click for additional information)
msg
  • Description: A response message reflecting the status of the operation
  • 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
additionalParameters
  • Description: Parameters required to deploy the application
  • Type: Object
© 2017-2019 Cisco Systems, Inc. All rights reserved