View Jobs

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView jobs
Description

Displays job-related information and resource links for each dependent or associated resource

Allowed Role(s)WM_USER
MethodGET
URI
  • v2/jobs
  • v2/jobs?search=[commaseparatedlistofSearchvalues]
    CloudCenter 4.9.0.1 and earlier releases
  • v2/jobs?search=commaseparatedlistofSearchvalues
    CloudCenter 4.9.1 and later releases – square brackets are no longer required for search values
  • v2/jobs?search=[deploymentEntity.name,fle,aug25]
    CloudCenter 4.9.0.1 and earlier releases
  • v2/jobs?search=deploymentEntity.name,fle,aug25
    CloudCenter 4.9.1 and later releases – square brackets are no longer required for search values

  • v2/jobs?showOnlyStorageEntity=true
  • v2/jobs?showOnlyFavorites=true&appId=appId&showDeploymentAttributes=true
  • v2/jobs?showAllJobs
  • cloudcenter-ccm-backend/api/v2/jobs
  • cloudcenter-ccm-backend/api/v2/jobs?search=[commaseparatedlistofSearchvalues]
    CloudCenter 4.9.0.1 and earlier releases
  • cloudcenter-ccm-backend/api/v2/jobs?search=commaseparatedlistofSearchvalues
    CloudCenter 4.9.1 and later releases – square brackets are no longer required for search values
  • cloudcenter-ccm-backend/api/v2/jobs?search=[deploymentEntity.name,fle,aug25]
    CloudCenter 4.9.0.1 and earlier releases
  • cloudcenter-ccm-backend/api/v2/jobs?search=deploymentEntity.name,fle,aug25
    CloudCenter 4.9.1 and later releases – square brackets are no longer required for search values

  • cloudcenter-ccm-backend/api/v2/jobs?showOnlyStorageEntity=true
  • cloudcenter-ccm-backend/api/v2/jobs?showOnlyFavorites=true&appId=appId&showDeploymentAttributes=true
  • cloudcenter-ccm-backend/api/v2/jobs?showAllJobs
Sample Request
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs?search=startTime,gtlt,08/15/2016,08/23/2016"
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v2/jobs?search=startTime,gtlt,08/15/2016,08/23/2016"
Release
  • Introduced in CloudCenter 4.6.
  • Enhanced in CloudCenter 4.8.0 to include the showAllJobs query parameter and list 50 records by default.
  • Enhanced in CloudCenter 4.8.2 to include the approvalRequestAction and approvalRequestStatus attributes.
  • Enhanced in CloudCenter 4.9.1 as follows (see Example 6 below):
    • To remove square brackets from search expressions.
    • To include the following elements:
      • estimatedSavingsPercentage
      • estimatedHourlyCost
      • estimatedMonthlyCost
      • estimatedMonthlySavings
      • addSuspensionPolicy
      • currencyCode
      • policySavings

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.
  • The v2 version of this API requires job objects for each cloud combination.

    • Default API response:
      • Only displays a list of jobs. Excludes the following jobs:

        • Project phase jobs

        • Benchmark jobs

      • Query parameters display benchmarks along with jobs.

    • Query parameters: See the Optional Query Parameters row in the Request Attributes section below.
    • Links: All resources that are independent of the job display a resource link with minimal information (id, resource). To view details about such resources, follow the corresponding links.  
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.jobs
  • action: get.jobs
    actionparam: search=[searchValue,searchValue,searchValue] – CloudCenter 4.9.0.1 and earlier releases
    actionparam: search=searchValue,searchValue,searchValue] – CloudCenter 4.9.1 and later releases
  • action: get.jobs
    actionparam: showOnlyStorageEntity=true
  • action: get.jobs
    actionparam:showOnlyFavorites=true&appId=appId&showDeploymentAttributes=true

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

Not applicable

Sample Response 1 – Search for jobs between two dates

 Search for deployments within a specified date range
{
    "resource": "https://<HOST>:<PORT>/v2/jobs?search=[startTime,gtlt,08/15/2016,08/23/2016]",
    "size": 4,
    "pageNumber": 0,
    "totalElements": 4,
    "totalPages": 1,
    "jobs": [{
        "id": "330",
        "resource": "https://<HOST>:<PORT>/v2/jobs/330",
        "name": "ven-test-aug18-1_run_1",
        "description": "",
        "status": "JobError",
        "jobStatusMessage": "Cloud : Openstack, Service : OpenstackComputeService, Error Code : CreationFailure, Error Message : Quota exceeded for ram: Requested 4096, but already used 49152 of 51200 ram",
        "startTime": "1471498985976",
        "endTime": "1471498990885",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "12.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=12.0"
        },
        "actions": [
            "MARK_FAVORITE",
            "TERMINATE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "152",
            "name": "ven-test-aug18-1"
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": false,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com"
    }, {
        "id": "329",
        "resource": "https://<HOST>:<PORT>/v2/jobs/329",
        "name": "ven-saas-aug17",
        "description": "",
        "status": "JobFinished",
        "jobStatusMessage": "",
        "startTime": "1471402824801",
        "endTime": "1471402824801",
        "favoriteCreationTime": "",
        "cloudFamily": "",
        "deploymentEnvironment": {
            "id": "",
            "resource": ""
        },
        "application": {
            "id": "35",
            "version": "1",
            "resource": "https://<HOST>:<PORT>/v1/apps/35?version=1"
        },
        "actions": [],
        "deploymentEntity": {
            "type": "JOB",
            "id": "329",
            "name": "ven-saas-aug17"
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": false,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com"
    }, {
        "id": "327",
        "resource": "https://<HOST>:<PORT>/v2/jobs/327",
        "name": "test11111",
        "description": "",
        "status": "JobRunning",
        "jobStatusMessage": "Submitted the deployment.",
        "startTime": "1471334525630",
        "endTime": "",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "12.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=12.0"
        },
        "actions": [
            "UPDATE_TAGS",
            "MARK_FAVORITE",
            "SUSPEND",
            "TERMINATE",
            "UPGRADE",
            "PROMOTE",
            "MIGRATE",
            "ON_TERMINATE_PROTECTION"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "151",
            "name": "test11111"
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": false,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 170,
        "nodeHours": 169.94478
    }, {
        "id": "325",
        "resource": "https://<HOST>:<PORT>/v2/jobs/325",
        "name": "ven-deploy-aug16-1_run_1",
        "description": "",
        "status": "JobError",
        "jobStatusMessage": "Cloud : Openstack, Service : OpenstackComputeService, Error Code : CreationFailure, Error Message : Quota exceeded for ram: Requested 4096, but already used 49152 of 51200 ram",
        "startTime": "1471321288940",
        "endTime": "1471321294008",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "12.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=12.0"
        },
        "actions": [
            "MARK_FAVORITE",
            "TERMINATE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "150",
            "name": "ven-deploy-aug16-1"
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": false,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com"
    }]
}

Example 2 – showOnlyStorageEntity=true

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs?showOnlyStorageEntity=true"

Response

 Search for deployments with storage
{
    "resource": "https://<HOST>:<PORT>/v2/jobs?showOnlyStorageEntity=true",
    "size": 1,
    "pageNumber": 0,
    "totalElements": 1,
    "totalPages": 1,
    "jobs": [{
        "id": "9",
        "resource": "https://<HOST>:<PORT>/v2/jobs/9",
        "name": "ven-jenkins2-may10_run_1",
        "description": "",
        "status": "JobRunning",
        "jobStatusMessage": "",
        "startTime": "1462867752197",
        "endTime": "",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "6.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=6.0"
        },
        "actions": [
            "SUSPEND",
            "TERMINATE",
            "UPGRADE",
            "PROMOTE",
            "MIGRATE",
            "ON_TERMINATE_PROTECTION",
            "MARK_FAVORITE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "5",
            "name": "ven-jenkins2-may10"
        },
        "storageEntities": [{
            "entity": "CHILD",
            "attributes": {
                "jobId": "10",
                "jobResource": "https://<HOST>:<PORT>/v2/jobs/10"
            }
        }],
        "terminateProtection": false,
        "favorite": false,
        "benchmark": false,
        "owner": true,
        "totalCost": 6.5520043,
        "nodeHours": 125.808205,
        "ownerEmailAddress": "admin@cliqrtech.com"
    }]
}

Example 3 –  showOnlyFavorites=true&appId=175&showDeploymentAttributes=true

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs?showOnlyFavorites=true&showDeploymentAttributes=true"

Response

 Search for favorite deployments and display attributes
{
    "resource": "https://<HOST>:<PORT>/v2/jobs?showOnlyFavorites=true&showDeploymentAttributes=true",
    "size": 9,
    "pageNumber": 0,
    "totalElements": 9,
    "totalPages": 1,
    "jobs": [{
        "id": "87",
        "resource": "https://<HOST>:<PORT>/v2/jobs/87",
        "name": "ven-test-log1_run_1",
        "description": "",
        "status": "JobRunning",
        "jobStatusMessage": "",
        "startTime": "1465578127976",
        "endTime": "",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "12.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=12.0"
        },
        "actions": [
            "UPDATE_TAGS",
            "REMOVE_FAVORITE",
            "UPGRADE",
            "PROMOTE",
            "OFF_TERMINATE_PROTECTION"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "40",
            "name": "ven-test-log1",
            "attributes": {
                "status": "Deployed",
                "health": "Down",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": true,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 3538,
        "nodeHours": 1768.6277
    }, {
        "id": "77",
        "resource": "https://<HOST>:<PORT>/v2/jobs/77",
        "name": "testjobstatus-1_run_1",
        "description": "",
        "status": "JobCanceled",
        "jobStatusMessage": "",
        "startTime": "1465312992873",
        "endTime": "1465313609184",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "12.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=12.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "HIDE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "35",
            "name": "testjobstatus-1",
            "attributes": {
                "status": "Terminated",
                "health": "No Status",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 2,
        "nodeHours": 0.16611111
    }, {
        "id": "36",
        "resource": "https://<HOST>:<PORT>/v2/jobs/36",
        "name": "jenkins-15",
        "description": "",
        "status": "JobCanceled",
        "jobStatusMessage": "",
        "startTime": "1461579294917",
        "endTime": "1461589039534",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "1.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=1.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "HIDE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "18",
            "name": "jenkins-15",
            "attributes": {
                "status": "Terminated",
                "health": "No Status",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 3,
        "nodeHours": 2.705
    }, {
        "id": "34",
        "resource": "https://<HOST>:<PORT>/v2/jobs/34",
        "name": "jenkins-14",
        "description": "",
        "status": "JobCanceled",
        "jobStatusMessage": "",
        "startTime": "1461577250021",
        "endTime": "1461589671461",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "1.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=1.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "HIDE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "17",
            "name": "jenkins-14",
            "attributes": {
                "status": "Terminated",
                "health": "No Status",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 4,
        "nodeHours": 3.4486113
    }, {
        "id": "32",
        "resource": "https://<HOST>:<PORT>/v2/jobs/32",
        "name": "jenkins-13",
        "description": "",
        "status": "JobError",
        "jobStatusMessage": "Instance bootstrapping is timed out, possibly due to incorrect or missing agent bundle for node f1a46d8b-893a-4eb3-ac60-08b7bf6e87dc",
        "startTime": "1461576936399",
        "endTime": "1461580795509",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "1.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=1.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "TERMINATE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "16",
            "name": "jenkins-13",
            "attributes": {
                "status": "Error",
                "health": "Error",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 2,
        "nodeHours": 1.0711111
    }, {
        "id": "28",
        "resource": "https://<HOST>:<PORT>/v2/jobs/28",
        "name": "jenkins-11",
        "description": "",
        "status": "JobError",
        "jobStatusMessage": "Network b5d2dca0-b856-48f9-b1b1-9e59b50b0223 could not be found.",
        "startTime": "1461576575782",
        "endTime": "1461576579309",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "1.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=1.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "TERMINATE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "14",
            "name": "jenkins-11",
            "attributes": {
                "status": "Error",
                "health": "Error",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com"
    }, {
        "id": "26",
        "resource": "https://<HOST>:<PORT>/v2/jobs/26",
        "name": "jenkins-10",
        "description": "",
        "status": "JobCanceled",
        "jobStatusMessage": "",
        "startTime": "1461576477966",
        "endTime": "1461576907849",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "1.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=1.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "HIDE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "13",
            "name": "jenkins-10",
            "attributes": {
                "status": "Terminated",
                "health": "No Status",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 1,
        "nodeHours": 0.11666667
    }, {
        "id": "22",
        "resource": "https://<HOST>:<PORT>/v2/jobs/22",
        "name": "jenkins_without_storage_run_1",
        "description": "",
        "status": "JobCanceled",
        "jobStatusMessage": "",
        "startTime": "1461569207527",
        "endTime": "1461576931535",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "7.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=7.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "HIDE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "11",
            "name": "jenkins_without_storage",
            "attributes": {
                "status": "Terminated",
                "health": "No Status",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 6,
        "nodeHours": 2.1436112
    }, {
        "id": "18",
        "resource": "https://<HOST>:<PORT>/v2/jobs/18",
        "name": "jenkins-7",
        "description": "",
        "status": "JobError",
        "jobStatusMessage": "Instance bootstrapping is timed out, possibly due to incorrect or missing agent bundle for node c9b6e18d-81bc-438d-9918-da47f8ab206e",
        "startTime": "1461561384560",
        "endTime": "1461565195633",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "1.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=1.0"
        },
        "actions": [
            "REMOVE_FAVORITE",
            "TERMINATE"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "9",
            "name": "jenkins-7",
            "attributes": {
                "status": "Error",
                "health": "Error",
                "ownerId": "2",
                "containsExternalServices": false
            }
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": true,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 2,
        "nodeHours": 1.0575
    }]
}

Example 4 – Using the deploymentEntity.name filter

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs?search=deploymentEntity.name,fle,aug25"

Response

 Search for jobs with a deployment name containing "aug25"
{
    "resource": "https://<HOST>:<PORT>/v2/jobs?search=[deploymentEntity.name,fle,aug25]",
    "size": 1,
    "pageNumber": 0,
    "totalElements": 1,
    "totalPages": 1,
    "jobs": [{
        "id": "336",
        "resource": "https://<HOST>:<PORT>/v2/jobs/336",
        "name": "ven-aug25-1",
        "description": "",
        "status": "JobRunning",
        "jobStatusMessage": "Job successfully scaled",
        "startTime": "1472102236141",
        "endTime": "",
        "favoriteCreationTime": "",
        "cloudFamily": "Openstack",
        "deploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "application": {
            "id": "33",
            "version": "12.0",
            "resource": "https://<HOST>:<PORT>/v1/apps/33?version=12.0"
        },
        "actions": [
            "UPDATE_TAGS",
            "MARK_FAVORITE",
            "SUSPEND",
            "TERMINATE",
            "UPGRADE",
            "PROMOTE",
            "MIGRATE",
            "ON_TERMINATE_PROTECTION"
        ],
        "deploymentEntity": {
            "type": "DEPLOYMENT",
            "id": "155",
            "name": "ven-aug25-1"
        },
        "terminateProtection": false,
        "hidden": false,
        "favorite": false,
        "benchmark": false,
        "owner": true,
        "ownerEmailAddress": "admin@cliqrtech.com",
        "totalCost": 44,
        "nodeHours": 42.234722
    }]
} 

Example 5 – ServiceNow Workflow

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs"

Response

 Click here to expand...
{
   "resource":"https://<HOST>:<PORT>/v2/jobs",
   "size":6,
   "pageNumber":0,
   "totalElements":6,
   "totalPages":1,
   "jobs":[
      {
         "id":"11",
         "resource":"https://<HOST>:<PORT>/v2/jobs/11",
         "name":"VenSnowTestNov19-1",
         "description":"",
         "status":"JobRunning",
         "jobStatusMessage":"",
         "approvalRequestStatus":"Suspend Pending Approval",
         "approvalRequestAction":"SUSPEND",
         "startTime":"1511129313611",
         "endTime":"",
         "scheduleEndTime":"",
         "timeZone":"",
         "favoriteCreationTime":"",
         "cloud":"Openstack-RegionOne",
         "cloudFamily":"Openstack",
         "cloudDisplayName":"Openstack RegionOne",
         "deploymentEnvironment":{
            "id":"2",
            "resource":"https://<HOST>:<PORT>/v1/environments/2"
         },
         "application":{
            "id":"29",
            "version":"14.04",
            "resource":"https://<HOST>:<PORT>/v1/apps/29?version=14.04"
         },
         "actions":[
            "MARK_FAVORITE",
            "EXPORT_TO_REPO",
            "CANCEL_APPROVAL_REQUEST",
            "RESEND_APPROVAL_REQUEST"
         ],
         "deploymentEntity":{
            "type":"DEPLOYMENT",
            "id":"6",
            "name":"VenSnowTestNov19-1"
         },
         "terminateProtection":false,
         "hidden":false,
         "favorite":false,
         "benchmark":false,
         "owner":false,
         "ownerEmailAddress":"user1@cliqrtech.com",
         "totalCost":34.5,
         "nodeHours":1123.8353,
         "customActions":[

         ]
      },
      {
         "id":"9",
         "resource":"https://<HOST>:<PORT>/v2/jobs/9",
         "name":"VenSnowDeploy1-Nov16",
         "description":"",
         "status":"JobCanceled",
         "jobStatusMessage":"",
         "approvalRequestStatus":"",
         "approvalRequestAction":"",
         "startTime":"1510876935930",
         "endTime":"1511129195982",
         "scheduleEndTime":"",
         "timeZone":"",
         "favoriteCreationTime":"",
         "cloud":"Openstack-RegionOne",
         "cloudFamily":"Openstack",
         "cloudDisplayName":"Openstack RegionOne",
         "deploymentEnvironment":{
            "id":"2",
            "resource":"https://<HOST>:<PORT>/v1/environments/2"
         },
         "application":{
            "id":"29",
            "version":"14.04",
            "resource":"https://<HOST>:<PORT>/v1/apps/29?version=14.04"
         },
         "actions":[
            "MARK_FAVORITE",
            "HIDE"
         ],
         "deploymentEntity":{
            "type":"DEPLOYMENT",
            "id":"5",
            "name":"VenSnowDeploy1-Nov16"
         },
         "terminateProtection":false,
         "hidden":false,
         "favorite":false,
         "benchmark":false,
         "owner":true,
         "ownerEmailAddress":"admin@cliqrtech.com",
         "totalCost":35.5,
         "nodeHours":2419.043,
         "customActions":[

         ]
      },
      {
         "id":"7",
         "resource":"https://<HOST>:<PORT>/v2/jobs/7",
         "name":"Ven-Deploy-Test3-Nov15",
         "description":"",
         "status":"JobRunning",
         "jobStatusMessage":"",
         "approvalRequestStatus":"",
         "approvalRequestAction":"",
         "startTime":"1510773673017",
         "endTime":"",
         "scheduleEndTime":"",
         "timeZone":"",
         "favoriteCreationTime":"",
         "cloud":"Openstack-RegionOne",
         "cloudFamily":"Openstack",
         "cloudDisplayName":"Openstack RegionOne",
         "deploymentEnvironment":{
            "id":"1",
            "resource":"https://<HOST>:<PORT>/v1/environments/1"
         },
         "application":{
            "id":"29",
            "version":"14.04",
            "resource":"https://<HOST>:<PORT>/v1/apps/29?version=14.04"
         },
         "actions":[
            "UPDATE_TAGS",
            "MARK_FAVORITE",
            "SUSPEND",
            "TERMINATE",
            "UPGRADE",
            "PROMOTE",
            "MIGRATE",
            "EXPORT_TO_REPO",
            "ON_TERMINATE_PROTECTION"
         ],
         "deploymentEntity":{
            "type":"DEPLOYMENT",
            "id":"4",
            "name":"Ven-Deploy-Test3-Nov15"
         },
         "terminateProtection":false,
         "hidden":false,
         "favorite":false,
         "benchmark":false,
         "owner":true,
         "ownerEmailAddress":"admin@cliqrtech.com",
         "totalCost":84,
         "nodeHours":167.60132,
         "customActions":[

         ]
      },
      {
         "id":"5",
         "resource":"https://<HOST>:<PORT>/v2/jobs/5",
         "name":"Ven-Deploy-Test2-Nov15",
         "description":"",
         "status":"JobCanceled",
         "jobStatusMessage":"",
         "approvalRequestStatus":"",
         "approvalRequestAction":"",
         "startTime":"1510773062547",
         "endTime":"1510773616823",
         "scheduleEndTime":"",
         "timeZone":"",
         "favoriteCreationTime":"",
         "cloud":"Openstack-RegionOne",
         "cloudFamily":"Openstack",
         "cloudDisplayName":"Openstack RegionOne",
         "deploymentEnvironment":{
            "id":"1",
            "resource":"https://<HOST>:<PORT>/v1/environments/1"
         },
         "application":{
            "id":"29",
            "version":"14.04",
            "resource":"https://<HOST>:<PORT>/v1/apps/29?version=14.04"
         },
         "actions":[
            "MARK_FAVORITE",
            "HIDE"
         ],
         "deploymentEntity":{
            "type":"DEPLOYMENT",
            "id":"3",
            "name":"Ven-Deploy-Test2-Nov15"
         },
         "terminateProtection":false,
         "hidden":false,
         "favorite":false,
         "benchmark":false,
         "owner":true,
         "ownerEmailAddress":"admin@cliqrtech.com",
         "totalCost":0.5,
         "nodeHours":0.14805555,
         "customActions":[

         ]
      },
      {
         "id":"3",
         "resource":"https://<HOST>:<PORT>/v2/jobs/3",
         "name":"Ven-Deploy-Test1-Nov15",
         "description":"",
         "status":"JobCanceled",
         "jobStatusMessage":"",
         "approvalRequestStatus":"",
         "approvalRequestAction":"",
         "startTime":"1510771987316",
         "endTime":"1510773236972",
         "scheduleEndTime":"",
         "timeZone":"",
         "favoriteCreationTime":"",
         "cloud":"Openstack-RegionOne",
         "cloudFamily":"Openstack",
         "cloudDisplayName":"Openstack RegionOne",
         "deploymentEnvironment":{
            "id":"1",
            "resource":"https://<HOST>:<PORT>/v1/environments/1"
         },
         "application":{
            "id":"29",
            "version":"14.04",
            "resource":"https://<HOST>:<PORT>/v1/apps/29?version=14.04"
         },
         "actions":[
            "MARK_FAVORITE",
            "HIDE"
         ],
         "deploymentEntity":{
            "type":"DEPLOYMENT",
            "id":"2",
            "name":"Ven-Deploy-Test1-Nov15"
         },
         "terminateProtection":false,
         "hidden":false,
         "favorite":false,
         "benchmark":false,
         "owner":true,
         "ownerEmailAddress":"admin@cliqrtech.com",
         "totalCost":0.5,
         "nodeHours":0.31916666,
         "customActions":[

         ]
      },
      {
         "id":"1",
         "resource":"https://<HOST>:<PORT>/v2/jobs/1",
         "name":"VenDeployTest1-Nov13",
         "description":"",
         "status":"JobCanceled",
         "jobStatusMessage":"",
         "approvalRequestStatus":"",
         "approvalRequestAction":"",
         "startTime":"1510614808646",
         "endTime":"1510773011837",
         "scheduleEndTime":"",
         "timeZone":"",
         "favoriteCreationTime":"",
         "cloud":"Openstack-RegionOne",
         "cloudFamily":"Openstack",
         "cloudDisplayName":"Openstack RegionOne",
         "deploymentEnvironment":{
            "id":"1",
            "resource":"https://<HOST>:<PORT>/v1/environments/1"
         },
         "application":{
            "id":"29",
            "version":"14.04",
            "resource":"https://<HOST>:<PORT>/v1/apps/29?version=14.04"
         },
         "actions":[
            "MARK_FAVORITE",
            "HIDE"
         ],
         "deploymentEntity":{
            "type":"DEPLOYMENT",
            "id":"1",
            "name":"VenDeployTest1-Nov13"
         },
         "terminateProtection":false,
         "hidden":false,
         "favorite":false,
         "benchmark":false,
         "owner":true,
         "ownerEmailAddress":"admin@cliqrtech.com",
         "totalCost":0.5,
         "nodeHours":0.5683333,
         "customActions":[

         ]
      }
   ]
}

Example 6 – Suspension Policy

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs"

Response

 Click here to expand...
{
	"resource": "https://<HOST>:<PORT>/v2/jobs",
	"size": 2,
	"pageNumber": 0,
	"totalElements": 2,
	"totalPages": 1,
	"jobs": [{
		"id": "43",
		"resource": "https://<HOST>:<PORT>/v2/jobs/43",
		"name": "DEP1",
		"description": "",
		"status": "JobRunning",
		"jobStatusMessage": "",
		"approvalRequestStatus": "",
		"approvalRequestAction": "",
		"startTime": "1525669318576",
		"endTime": "",
		"estimatedMonthlyCost": 1.3421664,
		"estimatedHourlyCost": 0.00186412,
		"estimatedMonthlySavings": 7.009834,
		"currencyCode": "USD",
		"policySavings": [{
			"type": "SUSPENSION_POLICY",
			"name": "pl_3",
			"estimatedSavingsPercentage": 83.93
		}],
		"addSuspensionPolicy": false,
		"scheduleEndTime": "",
		"timeZone": "",
		"favoriteCreationTime": "",
		"cloud": "AWS-us-east-1",
		"cloudFamily": "Amazon",
		"cloudDisplayName": "AWS US East (Virginia)",
		"deploymentEnvironment": {
			"id": "1",
			"resource": "https://<HOST>:<PORT>/v1/environments/1"
		},
		"application": {
			"id": "31",
			"version": "0.1",
			"resource": "https://<HOST>:<PORT>/v1/apps/31?version=0.1"
		},
		"actions": ["UPDATE_TAGS", "MARK_FAVORITE", "SUSPEND", "TERMINATE", "UPGRADE", "PROMOTE", "MIGRATE", "EXPORT_TO_REPO"],
		"deploymentEntity": {
			"type": "DEPLOYMENT",
			"id": "9",
			"name": "DEP1"
		},
		"terminateProtection": false,
		"hidden": false,
		"favorite": false,
		"benchmark": false,
		"owner": true,
		"ownerEmailAddress": "admin@cliqrtech.com",
		"totalCost": 0.058,
		"nodeHours": 4.9569445,
		"customActions": []
	}, {
		"id": "42",
		"resource": "https://<HOST>:<PORT>/v2/jobs/42",
		"name": "test-5",
		"description": "",
		"status": "JobError",
		"jobStatusMessage": "Failed to start job: null",
		"approvalRequestStatus": "",
		"approvalRequestAction": "",
		"startTime": "1525429821820",
		"endTime": "1525429824644",
		"estimatedMonthlyCost": 31.68,
		"estimatedHourlyCost": 0.044,
		"estimatedMonthlySavings": 0.0,
		"currencyCode": "USD",
		"policySavings": [],
		"addSuspensionPolicy": false,
		"scheduleEndTime": "",
		"timeZone": "",
		"favoriteCreationTime": "",
		"cloud": "AWS-us-east-1",
		"cloudFamily": "Amazon",
		"cloudDisplayName": "AWS US East (Virginia)",
		"deploymentEnvironment": {
			"id": "1",
			"resource": "https://<HOST>:<PORT>/v1/environments/1"
		},
		"application": {
			"id": "33",
			"version": "1",
			"resource": "https://<HOST>:<PORT>/v1/apps/33?version=1"
		},
		"actions": ["TERMINATE", "MARK_FAVORITE", "RERUN", "HIDE"],
		"deploymentEntity": {
			"type": "JOB",
			"id": "42",
			"name": "test-5"
		},
		"terminateProtection": false,
		"hidden": false,
		"favorite": false,
		"benchmark": false,
		"owner": true,
		"ownerEmailAddress": "admin@cliqrtech.com",
		"totalCost": 0.0,
		"nodeHours": 0.0,
		"customActions": []
	}]
}

Request Attributes

Optional – Query Parameters
 List of Query Parameters
page
  • Description: The total number of pages in for the API listing.

    • Default = 0

    • If size=0, then the page value is ignored.

    • If not specified (page=0&size=20), the default size (default = 20) value displays the first 20 elements, which is equal to one page
    • If you specify both the page and the size values, the following applies:

      If you specify......then
      size=21Elements numbered 21 - 40 entities are displayed, which is equal to 2 pages
      page=0
      (or not specified)
      The first set of 20 elements in the list, elements 1 to 20 are displayed
      page=1The second set of 20 elements in the list, elements 21 to 40 are displayed
      page=2

      The third set of 20 elements in the list (the third page).

      if the page does not have more than 10 elements, then only those 10 elements are displayed.

      page=1&&size=10A set of 10 elements, Elements 11 to 20 are displayed
      page=1&&size=20A set of 20 elements, Elements 21 to 40 are displayed
      page=2&&size=10A set of 10 elements, Elements 21 to 30 are displayed
  • Type: Integer
size
  • Description: Total number of records that any list page should contain. The default is: 

    • v1 APIs = 20 records

    • v2 APIs:

      • Prior to 4.8.0: All elements are returned and the page value is ignored.

      • Effective 4.8.0: 50 records
  • Type: Integer
 sort

sort
  • Description: Sorts API responses based on the format specified.
  • Type: String
    • Sorting order:
      • Ascending order = ASC
      • Descending order = DESC
    • Default: Sort criteria is based on startTime and DESC order.
    • Format: sort=[attribute, order]
    • Example: [endTime,ASC]
    • Sorting attributes:

      id
      • DescriptionUnique, system-generated identifier for this CloudCenter 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
      startTime
      endTime
      totalCost
      • Description: Identifies the total cost per hour of the job for billing purposes. See the CloudCenter Cost and Fees section for the relevant release to view additional details.

      • Type: Float

      nodeHours
      • Description: The number of VM hours for this resource. See the Financial Overview section for the relevant release to view additional details.

      • Type: Float

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

      • Type: String

      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.

      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

 search

  • Description: Searches API responses based on the format specified.
  • Type: String
    • Format: search=[field, searchType, SearchExpression1, SearchExpression2 ]
    • Example: search =[startTime, gt, 01/01/2016]

    • Search Expressions:
      • pattern: Provide a pattern using the format provided in the searchTypes table below.
      • searchTypes
        searchType
        Format
        eq
        ==
        ne
        !=
        el
        LIKE pattern%
        fl
        LIKE %pattern
        eln
        NOT LIKE pattern%
        fln
        NOT LIKE %pattern
        fle
        LIKE %pattern%"
        gt
        > searchValue
        lt
        < searchValue
        ge
        >= searchValue
        le
        <= searchValue
        gtlt
        searchValue && searchValue
        gtelt
        >= searchValue && < searchValue
        gtlte
        searchValue && <= searchValue
        gtelte
        >= searchValue && <= searchValue
        emp
        Empty string
        noemp
        Not Empty string
        nu
        Null value
        nn
        Not Null Value
      • searchValue:
        searchValueSearchType Availability
        ideq
        startTimeeq, nu, gtlt
        endTimeeq, nu, nn, gtlt
        totalCosteq, gt, ge, le, gtlt, gtlte, gtelte, gtelt
        favoriteCreationTimeeq, nu, ,nn gtlt
        jobStatusMessageel, eln, fl, fln, fle, nn, emp, noemp
        nodeHourseq, gt, ge, le, gtlt, gtlte, gtelte, gtelt
        nameeq, nn, eln, fle, fln, el, emp, noemp, fl
        descriptioneq, nn, eln, fle, fln, el, emp, noemp, fl
        deploymentEntity.nameeq, nn, eln, fle, fln, el, emp, noemp, fl
        ownerEmailAddresseq
        cloudFamilyeq, nu
        statuseq, nu

includeStatus
  • Description: Identifies the job status that should be listed in the response. See Deployment and VM States for additional context.
  • Type: Comma separated status as a string.
    • Default Status: all
    • Available States:

       List of Available Job States

      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

       

excludeStatus
  • Description: Identifies the job status that should be excluded in the response. See Deployment and VM States for additional context.
  • Type: Comma separated status as a string.
    • Default Status: all
    • Available Status:

       List of Available Job States

      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

       

includeBenchmarkStatus
  • Description: Identifies if the benchmark status is marked for inclusion. See Benchmark Applications and API Error Codes for additional context.
  • Type: Boolean
    • false = Does not include benchmark status for jobs.
    • true = Includes the benchmark status for jobs.
      • Requirement: You can specify the includeBenchmarkStatus setting as a query param only if you provide the includeBenchmark=true or the showOnlyBenchmark=true settings.
      • Default Status: all
      • Available Status: List of available benchmark states.

         List of Available Job States

        status (v2 benchmarks)
        • Type: Comma separated Statuses as String

          all (default)
          BenchmarkSubmitted
          BenchmarkProgress
          BenchmarkPartial
          BenchmarkError
          BenchmarkCanceled
          BenchmarkComplete

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See the Deployment Environments section for the relevant release for additional details. This attribute is the same as the environmentId attribute.

  • Type: String

includeJobsWithPhases
  • Description: Identifies if jobs with phases must be included in the API response. See Projects and Phases for additional context.
  • Type: Boolean
    • true = Includes project-phase jobs.
    • false = Default. Excludes project-phase jobs.

showOnlyJobsWithPhases
  • Description: Identifies if jobs with phases must be displayed in the API response. See Projects and Phases for additional context.
  • Type: Boolean
    • true = Displays the project-phase jobs.
    • false = Default. Displays all jobs except the project-phase jobs.

Dependent on includeJobsWithPhases=true setting
phaseId
  • DescriptionUnique, system-generated identifier for the phase.
  • Type: String
showOnlyStorageEntity
  • Type: Boolean
    • true = Displays storage details for jobs.
    • false = Default. Does not display storage details for jobs.

appId
  • Description: Unique, system-generated identifier for the application profile. You can provide multiple application profile IDs as input parameters.

  • Type: String
showOnlyFavorites
  • Description: Identifies if a job/deployment is marked as a favorite by a user. See Job Runs and Job Details > Favorite Deployments for additional context.
  • Type: Boolean

    • true = Displays jobs marked as favorite
    • false = (default) Displays marked and unmarked jobs
showDeploymentAttributes
  • Type: Boolean
    • true = Displays attributes for the deployment.
    • false = Default. Does not attributes for the deployment.

includeBenchmark
  • Description: Identifies if a job/deployment is benchmarked by a user. See the Benchmark Applications section for the relevant release for additional context.

    The includeBenchmark attribute and the showOnlyBenchmark attribute are mutually exclusive – use one or the other.


  • Type: Boolean

    • true = (default) Displays benchmarked jobs
    • false = Excludes benchmarked jobs
showOnlyBenchmark
  • Description: Identifies the benchmark status that should be listed in the response. See Benchmark Applications and API Error Codes for additional context.

    The includeBenchmark attribute and the showOnlyBenchmark attribute are mutually exclusive – use one or the other.

  • Type: Boolean
    • false = Does not include benchmark status for jobs.
    • true = Displays the benchmark status for jobs.
      • Requirement: You can specify the includeBenchmarkStatus setting as a query param only if you provide the includeBenchmark=true or the showOnlyBenchmark=true settings.
      • Default Status: all
      • Available States:

         List of Available Job States

        status (v2 benchmarks)
        • Type: Comma separated Statuses as String

          all (default)
          BenchmarkSubmitted
          BenchmarkProgress
          BenchmarkPartial
          BenchmarkError
          BenchmarkCanceled
          BenchmarkComplete

showBenchmarkEntity
  • Description: Identifies the benchmark details if the job contains benchmarks. See Benchmark Applications for additional context.
  • Type: Boolean
    • true = Displays benchmark details for jobs.
    • false = Does not include benchmark details for jobs.
includeHiddenJobs
  • Type: Boolean
    • true = Displays hidden jobs.
    • false = Default. Does not include hidden jobs.
accessAsAdmin
  • Description: Identifies if you want to view all user jobs as root (or) as a (sub)tenant admin. See Admin Users for additional context.
  • Type: Boolean
    • true = Uses admin access to view all user jobs
    • false = Default. Does not use admin access to view all user jobs.
showAllJobs
  • Description: A query parameter that displays all v2 jobs — only available for v2 APIs effective CloudCenter 4.8.0.
  • Type: Boolean
    • true = Displays all records for this v2 job.
    • false = Default. Displays the first 50 records for this v2 job.


Response Attributes

 List of Optional Page Filters

pageResource
  • Description: Identifies the pagination information for each resource
  • Type: Sequence of attributes for v2 APIs

     Click here to expand...
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    size
    • Description: Total number of records that any list page should contain. The default is: 

      • v1 APIs = 20 records

      • v2 APIs:

        • Prior to 4.8.0: All elements are returned and the page value is ignored.

        • Effective 4.8.0: 50 records
    • Type: Integer
    pageNumber
    • Description: The page number that the client wants to fetch. Page numbers start with 0 (default).
    • Type: Integer
    totalPages
    • Description: The number of pages in a response 
    • Type: Integer
    jobs
    • Description: Array of JSON objects that use jobs as the key.                                                                  
    • Type: Array of JSON objects
    previousPage
    • Description: A resource link to the previous page.
    • Type: URI as a string
    nextPage
    • Description: A resource link to the following page.
    • Type: URI as a string
    lastPage
    • Description: A resource link to the last page.
    • Type: URI as a string

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