Delete Job

Details

API Details
NameDelete Job
DescriptionDelete a deployment. This API returns a reference to a tracking ID that can be used to retrieve the delete operation.
MethodDELETE
URI
  • /v2/jobs/jobId
  • /v2/jobs/jobId?hide=true
CloudCenter ReleaseIntroduced in CloudCenter 4.6
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • Default = terminate and hide ( if no variable is passed). See Termination for additional context.
  • If hide = true and successful, then behavior is the same as terminate and hide.
  • If hide = false and successful, then  only terminate (without hiding).
ESB Header
  • action: delete.jobs.jobId
  • action: delete.jobs.jobId
    actionparam: hide=true

Example

curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/920" 

Response

The API starts bringing down the VMs launched for this deployment. The response to this API would be a reference to a resource that provides latest status of the operation.

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

This resource can be queried to get the latest status of the stop operation:

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

The server responds with the following message once the deployment is successfully deleted:

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

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
supportedActions
  • Description: Identifies the supported actions for each deployment. Users can perform several functions based on their deployment permissions.

    The User Privilege (see perms and Permission Control) and Job Status (see Deployment and VM States) determine the supported actions for each user. For example:

    • User Privilege: If you only have View privileges, you can only view (GET) the job details, you cannot manage the jobs/deployments.
    • Job Status: You can only see the RESUME option if the job/deployment is in a SUSPENDED state.

  • Type: Enumeration

    Enumeration Description
    APPROVEApprove a deployment request.
    DEMOTEDemote a deployment.
    DENYDeny a deployment request.
    HIDEJust hide this job (for jobs with Errors)
    MARK_FAVORITEMark a job or deployment as a favorite (see Deployments > Favorite Deployments for additional context)
    MIGRATE

    Migrate deployment – provide the following block for promoting the application:

    PUT https://<CCM HOST NAME>:<PORT>/v2/jobs/{jobId}

    Points to be noted if approval is required:

    • The MIGRATE request triggers an automatic backup process.
    • Migrate is not supported for Project-based deployments.
    • If Rejected when approval is required, no change – deployment continues to run.
    • If Approved and:
      • Successful (deployed) – Deployment is terminated (if requested via the keepExistingDeployment=true setting).
      • Migrate Fails – Deployment is suspended.
    ON_TERMINATE_PROTECTION Prevent an inadvertent stoppage from the CloudCenter platform and thus avoid interrupting production deployments by turning on the preventTermination feature. See Termination for additional context.
    OFF_TERMINATE_PROTECTION Turn off the preventTermination feature. See Termination for additional context.
    PROMOTE

    Promote a deployment – provide the following block for promoting the application:

    PUT https://<CCM HOST NAME>:<PORT>/v2/jobs/{jobId}

    Points to be noted if approval is required:

    • The PROMOTE request does not trigger a backup process.
    • If Rejected, no change – Deployment continues to run.
    • If Approved and:
      • Successful (deployed) – Deployment is terminated (if requested via the keepExistingDeployment=true setting).
      • Fails – deployment is suspended
    REMOVE_FAVORITEUn-marks a job or deployment as a favorite (see Deployments > Favorite Deployments for additional context)
    RERUNRerun the deployment – valid only for batch jobs.
    RESUMEResume a deployment – valid only for deployments.
    STARTStart a deployment.
    STOPStop a deployment – valid for both deployments and legacy jobs. It just stops the deployment (or) job.
    SUSPEND Suspend a deployment – valid only for deployments and not legacy jobs
    TERMINATETerminate a deployment.
    TERMINATE_AND_HIDETerminates and hides the deployment.

    UPDATE_TAGS

    Update tags as part of Job. If Governance mode is ON, Security profiles, policies (Aging, Scaling policies) can be updated (Update involves update, creation, deletion). See Governance for additional context.
    UPGRADEUpgrade a deployment to the next version – provide the next version of the Application to be upgraded.