jobs
  • Description: Information about the jobs for this deployment.

  • Type: Sequence of JSON objects

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

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    status (v2 jobs)
    • Description: Supported job status for the includeStatus and excludeStatus attributes.
    • Type: String

      all (default)
      active
      JobFinished
      JobRunning
      JobStarting
      JobSubmitted
      JobCanceled
      JobCancelling
      JobError
      JobPending
      JobStopped
      JobStopping
      JobStoppingError
      JobScaling
      JobRejected
      JobMigrating
      JobMigrationError
      JobUpgrading
      JobUpgradeError
      JobSuspending
      JobSuspended
      JobResuming
      JobReconfiguring

     

    jobStatusMessage
    • Description: Identifies the message associated with the job status as a result of the most recent action. See Deployment and VM States or API Error Codes for additional context.
      • v2 APIs: Contain job status message.
      • v1 APIs: Do not contain job status message.
    • Type: String

    approvalRequestAction
    • Description: The available actions for an approval workflow when using ServiceNow extensions in CloudCenter to request approval. See the ServiceNow Extension Workflow Requests section in the Application Deployment, VM, and Container States section for the relevant release for additional context.

    • Type: Enumeration


    approvalRequestStatus
    • Description: The status for each approval workflow request when using ServiceNow extensions in CloudCenter to request approval. See the ServiceNow Extension Workflow Requests section in the Application Deployment, VM, and Container States section for the relevant release for additional context.

    • Type: String


    startTime

    endTime

    estimatedMonthlyCost
    • Description: Identifies the approximate cost for each month based on the uptime schedule. Blockout dates are not used in this calculation as the time frame is indeterminate.

    • Type: Float

    estimatedHourlyCost
    • Description: Identifies the approximate cost for each hour based on the uptime schedule. Blockout dates are not used in this calculation as the time frame is indeterminate.

    • Type: Float

    estimatedMonthlySavings
    • Description: Identifies the approximate savings for each month based on the uptime schedule. Blockout dates are not used in this calculation as the timeframe is indeterminate.

    • Type: Float

    currencyCode
    • Description: Identifies the ISO code of the currency selected at the tenant level by the tenant admin. Currently, Cloud Center supports the currencies listed in the following table.

      Currency CodeDescription
      USDUnited States Dollars
      GBPUnited Kingdom Pound
      AUDAustralian Dollar
      EUREuro
      JPYJapan Yen
      CNYChina Yuan Renminbi
    • Type: String


    policySavings
    • Description: Identifies the expected percent cost savings.

    • Type: Array of savings details

      estimatedSavingsPercentage
      • Description: Estimates the savings percentage and is updated whenever schedule type/scheduled days, start time/end time of schedule are changed. Blockout dates are not used in this calculation as the time frame is indeterminate.

      • Type: Float

      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      type
      • DescriptionThe type of resource
      • Type: String

    addSuspensionPolicy
    • Description: Identifies if the suspension policy is already added for a deployment. 

    • Type: Boolean

      • true = You can add a suspension policy for this deployment.

      • false = This deployment already has a suspension policy and you cannot add another suspension policy for this deployment.

    favoriteCreationTime
    • Description: If the job was configured as a favorite job, then this attribute identifies the time when this configuration took place. See the Favorite Deployments section for the relevant release for additional context.
    • Type: Epoch time as a String
    cloudFamily                                                                                                                                                                                
    • Description: The cloud provider name.                     
    • Type: String
    deploymentEnvironment
    • Description: Identifies details for the deployment environment.
    • Type: Sequence of objects

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

      • Type: String
      resource
      • Description: Unique URL to access this resource.
      • Type: String
    actions
     Click here to expand...

    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.
      CANCEL_APPROVAL_REQUESTCancel the current approval request for a ServiceNow workflow.
      DEMOTEDemote a deployment.
      DENYDeny a deployment request.
      EXTEND_AGEExtend the age of the Aging Policy attached to the job.
      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.
      RESEND_APPROVAL_REQUESTResend the approval request for a ServiceNow workflow to the ServiceNow admin.
      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.

    deploymentEntity
     Click here to expand...

    deploymentEntity.name
    • Description: Identifies evolving resource details about the deployment. The deploymentEntity attribute uses the deploymentEntity.name format, where .name is search value for deploymentEntity and deploymentEntity itself is a JSON object.

      Instead of placing the deployment name at the top level search and adding numerous query parameters, this format allows for nested search results. The top level name is the job name and deploymentEntity.name is the deployment name.

    • Type: JSON objects

      type
      • DescriptionThe type of resource
      • Type: String

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

      • Type: String

      The ID for the job or deployment

      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      The name for the job or deployment

      attributes
      • Description: Identifies attribute details for the deployment entity.
      • Type: Sequence of related information about the resource – these details differ based on the resource being deployed.

     terminateProtection 
    • Description: Identifies if terminate protection enabled for the deployment for this job. See the Terminate Protection section for the relevant release for additional context.
      • true = Terminate protection is enabled.
      • false = Default. Terminate protection is disabled.
    • Type: Boolean
    hidden
    • Description: Hides a job/deployment. See Termination > Terminate Existing Deployment  for additional context.
    • Type: Boolean
      • true = Hides the job/deployment.
      • false = Default. Does not hide the job/deployment.
    favorite
    • Description: Marks a job or a deployment as a favorite for the user. See Deployments > Favorite Deployments for additional context. This attribute is the same as the userFavorite attribute.
    • Type: Boolean
      • true = Marks this job as a favorite for the user.
      • false = Default. Does not mark the job as a favorite.
    benchmark
    • Description: Identifies if the benchmark status is marked for inclusion. See Benchmark Applications and API Error Codes for additional context. This attribute is the same as the benchmarkJob attribute.
    • Type: Boolean
      • true = Marks the benchmark status for inclusion.
      • false = Default. The benchmark status is not marked for inclusion.
    owner
    • Description: Indicates whether this user is the job/deployment owner. This attribute is the same as the isOwner attribute.
    • Type: Boolean
      • true = This user is the job/deployment owner
      • false = Default. This user is not the job/deployment owner
    ownerEmailAddress
    • Description: The email address of the resource owner (author)
    • Type: String



© 2017-2019 Cisco Systems, Inc. All rights reserved