// removed jquery ui css and js

View Job Details

Details

API Details
NameView jobs
Description

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

MethodGET
URI
  • v2/jobs/jobId
  • v2/jobs/jobId?includeNodeDetails=true&includeNodeCostDetails=true&includeTaskDetails=true
CloudCenter Release
  • Introduced in CloudCenter 4.6
  • Enhanced to include the virtualMachineId and externalServiceInstance attributes in CloudCenter 4.8.1.
Notes
  • General Notes:
    • Ports: For additional context on <PORT> usage in the following example(s), see Base URI Format.
    • Query parameters: See the Optional Query Parameters row in the Request Attributes section below. See View Jobs for examples. 
    • 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.

  • API Notes:
    • Child job details:
      • Details for a child job are not displayed in the parent job details. Instead, use the child job link to view details for the child job.
      • Correspondingly, each child job contains a link back to the parent job.
    • Action attributes: The parent actions and child actions are segregated as applicable to the child or the parent.
    • Approval attributes: All attributes relating to approval are grouped under the parent job.

ESB Header
  • action: get.jobs.jobId
  • action: get.jobs.jobId
    actionparam:includeNodeDetails=true&includeNodeCostDetails=true&includeTaskDetails=true

Example 1 – Parent Job

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

Response

 Click here to expand...
{
    "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": "327",
        "name": "test11111",
        "attributes": {
            "status": "Deployed",
            "health": "Healthy",
            "ownerId": "2",
            "containsExternalServices": false
        }
    },
    "terminateProtection": false,
    "hidden": false,
    "favorite": false,
    "benchmark": false,
    "owner": true,
    "ownerEmailAddress": "admin@cliqrtech.com",
    "parentJob": {
        "id": "",
        "resource": ""
    },
    "lastUpdatedTime": "1471857578009",
    "bareMetalMachines": [],
    "accessLink": "http://10.0.0.242",
    "parameters": {
        "cloudParams": {
            "cloudRegionId": 1,
            "instance": "",
            "instanceName": "",
            "nics": [],
            "volumes": [],
            "provisionBareMetal": false,
            "deploymentIsolationTag": "",
            "autoCloudAndInstanceSelection": false,
            "selectionCriteria": "NONE",
            "accountId": "1",
            "rootVolumeSize": "",
            "storage": "",
            "networkTypeName": "",
            "cloudProperties": [{
                "name": "numNICs",
                "value": "1"
            }]
        },
        "appParams": [{
            "name": "appPackage",
            "value": ""
        }, {
            "name": "cliqrWebappAccessLink",
            "value": ""
        }, {
            "name": "cliqrForceHttpRedirect",
            "value": "0"
        }, {
            "name": "SharedStorageMount",
            "value": "/shared"
        }, {
            "name": "SharedStorageName",
            "value": "mystor"
        }, {
            "name": "OSSVC_HOME",
            "value": "/usr/local/osmosix/service"
        }, {
            "name": "cliqrIgnoreAppFailure",
            "value": "true"
        }, {
            "name": "cliqrExternalHttpEnabled",
            "value": "1"
        }, {
            "name": "cliqrUseCustomCert",
            "value": "0"
        }, {
            "name": "cliqrSSLCert",
            "value": ""
        }, {
            "name": "cliqrAppTierName",
            "value": "test11111"
        }, {
            "name": "launchVendorId",
            "value": "1"
        }, {
            "name": "cliqrAppType",
            "value": "n-tier"
        }, {
            "name": "cliqrSSLKey",
            "value": ""
        }, {
            "name": "cloudConfigFilePath",
            "value": "/root/ven.txt"
        }, {
            "name": "cliqrExternalNoProtocolEnabled",
            "value": "0"
        }, {
            "name": "pathParamNames_app_33_order_0",
            "value": "appPackage"
        }, {
            "name": "cloudConfigFileContents",
            "value": "%NIC1_IP%\n%NIC2_IP%\n%NIC3_IP%\n\nIP Addresses:  %NIC1_IP%  , %NIC2_IP%  ,\n%NIC3_IP% "
        }, {
            "name": "cliqrExternalHttpsEnabled",
            "value": "0"
        }, {
            "name": "launchUserName",
            "value": "cliqradmin"
        }, {
            "name": "microSegmentation",
            "value": "0"
        }, {
            "name": "cliqrAppName",
            "value": "Jenkins_no_storage1"
        }, {
            "name": "CliqrDepEnvName",
            "value": "Ven-Deploy-Env1"
        }, {
            "name": "bareMetalMachine",
            "value": "false"
        }, {
            "name": "launchUserId",
            "value": "2"
        }, {
            "name": "CliqrDepEnvId",
            "value": "1"
        }, {
            "name": "cliqrNonStandardPort",
            "value": ""
        }, {
            "name": "useNonStandardPort",
            "value": "0"
        }, {
            "name": "launchIdent",
            "value": "{user}cliqradmin{group}{vendor}1"
        }, {
            "name": "parentJobName",
            "value": "test11111"
        }, {
            "name": "NumNodes",
            "value": "1"
        }],
        "envParams": [{
            "name": "appPackage",
            "value": ""
        }, {
            "name": "cliqrWebappAccessLink",
            "value": ""
        }, {
            "name": "cliqrForceHttpRedirect",
            "value": "0"
        }, {
            "name": "SharedStorageMount",
            "value": "/shared"
        }, {
            "name": "SharedStorageName",
            "value": "mystor"
        }, {
            "name": "OSSVC_HOME",
            "value": "/usr/local/osmosix/service"
        }, {
            "name": "cliqrIgnoreAppFailure",
            "value": "true"
        }, {
            "name": "cliqrExternalHttpEnabled",
            "value": "1"
        }, {
            "name": "cliqrUseCustomCert",
            "value": "0"
        }, {
            "name": "cliqrSSLCert",
            "value": ""
        }, {
            "name": "cliqrAppTierName",
            "value": "test11111"
        }, {
            "name": "launchVendorId",
            "value": "1"
        }, {
            "name": "cliqrAppType",
            "value": "n-tier"
        }, {
            "name": "cliqrSSLKey",
            "value": ""
        }, {
            "name": "cloudConfigFilePath",
            "value": "/root/ven.txt"
        }, {
            "name": "cliqrExternalNoProtocolEnabled",
            "value": "0"
        }, {
            "name": "pathParamNames_app_33_order_0",
            "value": "appPackage"
        }, {
            "name": "cloudConfigFileContents",
            "value": "%NIC1_IP%\n%NIC2_IP%\n%NIC3_IP%\n\nIP Addresses:  %NIC1_IP%  , %NIC2_IP%  ,\n%NIC3_IP% "
        }, {
            "name": "cliqrExternalHttpsEnabled",
            "value": "0"
        }, {
            "name": "launchUserName",
            "value": "cliqradmin"
        }, {
            "name": "microSegmentation",
            "value": "0"
        }, {
            "name": "cliqrAppName",
            "value": "Jenkins_no_storage1"
        }, {
            "name": "CliqrDepEnvName",
            "value": "Ven-Deploy-Env1"
        }, {
            "name": "bareMetalMachine",
            "value": "false"
        }, {
            "name": "launchUserId",
            "value": "2"
        }, {
            "name": "CliqrDepEnvId",
            "value": "1"
        }, {
            "name": "cliqrNonStandardPort",
            "value": ""
        }, {
            "name": "useNonStandardPort",
            "value": "0"
        }, {
            "name": "launchIdent",
            "value": "{user}cliqradmin{group}{vendor}1"
        }, {
            "name": "parentJobName",
            "value": "test11111"
        }, {
            "name": "NumNodes",
            "value": "1"
        }],
        "nodeParams": []
    },
    "virtualMachines": [],
    "approvalRequest": {
        "currentDeploymentEnvironment": {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/environments/1"
        },
        "fromDeploymentEnvironment": {
            "id": "",
            "resource": ""
        },
        "initiatingUser": {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/users/2"
        },
        "approvingUser": {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/users/2"
        },
        "requestTime": "1471334522308",
        "approvalTime": "1471334522308",
        "status": "AUTO_APPROVED",
        "message": "Auto-Approved"
    },
    "childJobs": [{
        "id": "328",
        "resource": "https://<HOST>:<PORT>/v2/jobs/328",
        "dependencies": []
    }],
    "tags": [{
        "id": "1",
        "resource": "https://<HOST>:<PORT>/v1/systemTags/1"
    }],
    "policyIds": [],
    "securityProfiles": [],
    "windowsJob": false,
    "scalable": false,
    "metadata": [{
        "namespace": "",
        "name": "vm",
        "value": "vmv",
        "editable": false,
        "required": false
    }, {
        "namespace": "",
        "name": "VTag1",
        "value": "USER_DEFINED_TAG",
        "editable": false,
        "required": false
    }]
}

Example 2 –  Child Job

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

Response

 Click here to expand...
{
    "id": "328",
    "resource": "https://<HOST>:<PORT>/v2/jobs/328",
    "name": "WebServer",
    "description": "",
    "status": "JobRunning",
    "jobStatusMessage": "",
    "startTime": "1471334525988",
    "endTime": "",
    "favoriteCreationTime": "",
    "cloudFamily": "Openstack",
    "deploymentEnvironment": {
        "id": "",
        "resource": ""
    },
    "application": {
        "id": "34",
        "version": "12.0",
        "resource": "https://<HOST>:<PORT>/v1/apps/34?version=12.0"
    },
    "actions": [
        "SCALE_UP",
        "SCALE_DOWN",
        "UPDATE_TAGS"
    ],
    "terminateProtection": false,
    "hidden": false,
    "favorite": false,
    "benchmark": false,
    "owner": true,
    "ownerEmailAddress": "admin@cliqrtech.com",
    "parentJob": {
        "id": "327",
        "resource": "https://<HOST>:<PORT>/v2/jobs/327"
    },
    "lastUpdatedTime": "1471857577792",
    "bareMetalMachines": [],
    "accessLink": "",
    "parameters": {
        "cloudParams": {
            "cloudRegionId": 1,
            "instance": "37ea4c37-7301-4689-8431-9ce89e55068f",
            "instanceName": "m1.xlarge",
            "nics": [{
                "id": "95845aef-995e-42d9-8d63-f2572e3cff9f",
                "type": "NETWORK",
                "allocationMode": "DHCP",
                "order": 1,
                "allocatePublicIp": true,
                "properties": []
            }],
            "volumes": [],
            "provisionBareMetal": false,
            "deploymentIsolationTag": "",
            "autoCloudAndInstanceSelection": false,
            "selectionCriteria": "NONE",
            "accountId": "1",
            "rootVolumeSize": "",
            "storage": "",
            "networkTypeName": "",
            "cloudProperties": [{
                "name": "availabilitySet",
                "value": "nova"
            }, {
                "name": "TenantName",
                "value": "venkatadri"
            }, {
                "name": "numNICs",
                "value": "1"
            }, {
                "name": "provisionInAvailabilitySet",
                "value": "true"
            }]
        },
        "appParams": [{
            "name": "appPackage",
            "value": ""
        }, {
            "name": "cliqrWebappAccessLink",
            "value": ""
        }, {
            "name": "SharedStorageName",
            "value": "mystor"
        }, {
            "name": "OSSVC_HOME",
            "value": "/usr/local/osmosix/service"
        }, {
            "name": "cliqrTomcat6PostStartAction",
            "value": ""
        }, {
            "name": "cliqrWebappContext",
            "value": "ROOT"
        }, {
            "name": "cliqrExternalHttpEnabled",
            "value": "1"
        }, {
            "name": "cliqrTomcat6PostStopAction",
            "value": ""
        }, {
            "name": "cliqrDBDataStorageSize",
            "value": "0"
        }, {
            "name": "minClusterSize",
            "value": "1"
        }, {
            "name": "defaultService",
            "value": ""
        }, {
            "name": "cliqrSSLCert",
            "value": ""
        }, {
            "name": "launchVendorId",
            "value": "1"
        }, {
            "name": "cliqrSSLKey",
            "value": ""
        }, {
            "name": "cliqrWARFile",
            "value": "http://env.cliqrtech.com/jenkins/jenkins.war"
        }, {
            "name": "pathParamNames_app_34_order_0",
            "value": "cliqrWARFile,cliqrTomcat6PreStartAction,cliqrTomcat6PostStartAction,cliqrTomcat6PreStopAction,cliqrTomcat6PostStopAction,cliqrExternalPreStartAction,cliqrExternalPreInitAction,cliqrExternalPostStartAction,cliqrExternalPreStopAction,cliqrExternalPostStopAction,resumeScript"
        }, {
            "name": "cliqrExternalNoProtocolEnabled",
            "value": "0"
        }, {
            "name": "cliqrExternalPreStartAction",
            "value": ""
        }, {
            "name": "cliqrExternalHttpsEnabled",
            "value": "0"
        }, {
            "name": "launchUserName",
            "value": "cliqradmin"
        }, {
            "name": "bareMetalMachine",
            "value": "false"
        }, {
            "name": "cliqrNoOfVolumes",
            "value": "0"
        }, {
            "name": "cliqrNonStandardPort",
            "value": ""
        }, {
            "name": "maxClusterSize",
            "value": "3"
        }, {
            "name": "cliqrJDKVersion",
            "value": "JDK6"
        }, {
            "name": "cliqrWebappConfigFiles",
            "value": ""
        }, {
            "name": "parentJobName",
            "value": "test11111"
        }, {
            "name": "cliqrTomcat6PreStartAction",
            "value": ""
        }, {
            "name": "NumNodes",
            "value": "1"
        }, {
            "name": "cliqrForceHttpRedirect",
            "value": "0"
        }, {
            "name": "SharedStorageMount",
            "value": "/shared"
        }, {
            "name": "resumeScript",
            "value": ""
        }, {
            "name": "TopologyNodeParams",
            "value": "{\"x\":\"150\",\"y\":\"120\"}"
        }, {
            "name": "cliqrIgnoreAppFailure",
            "value": "true"
        }, {
            "name": "tierOrder",
            "value": "1"
        }, {
            "name": "cliqrPlanPath",
            "value": ""
        }, {
            "name": "cliqrUseCustomCert",
            "value": "0"
        }, {
            "name": "cliqrTomcat6PreStopAction",
            "value": ""
        }, {
            "name": "cliqrAppTierName",
            "value": "test11111"
        }, {
            "name": "cliqrAppType",
            "value": "defaultApp"
        }, {
            "name": "cliqrExternalPostStartAction",
            "value": ""
        }, {
            "name": "cloudConfigFilePath",
            "value": "/root/venkat.txt"
        }, {
            "name": "pathParamNames_app_33_order_0",
            "value": "appPackage"
        }, {
            "name": "cloudConfigFileContents",
            "value": "%NIC1_IP%\n%NIC2_IP%\n%NIC3_IP%\n\nIP Addresses:  %NIC1_IP%  , %NIC2_IP%  ,\n%NIC3_IP% "
        }, {
            "name": "topTier",
            "value": "true"
        }, {
            "name": "cliqrExternalPreInitAction",
            "value": ""
        }, {
            "name": "microSegmentation",
            "value": "0"
        }, {
            "name": "cliqrAppName",
            "value": "WebServer"
        }, {
            "name": "cliqrExternalPostStopAction",
            "value": ""
        }, {
            "name": "sshUserName",
            "value": "cliqruser"
        }, {
            "name": "CliqrDepEnvName",
            "value": "Venkat-Deploy-Env1"
        }, {
            "name": "cliqrExternalPreStopAction",
            "value": ""
        }, {
            "name": "launchUserId",
            "value": "2"
        }, {
            "name": "CliqrDepEnvId",
            "value": "1"
        }, {
            "name": "cliqrEARPath",
            "value": ""
        }, {
            "name": "OSSVC_CONFIG",
            "value": "tomcat6"
        }, {
            "name": "useNonStandardPort",
            "value": "0"
        }, {
            "name": "launchIdent",
            "value": "{user}cliqradmin{group}{vendor}1"
        }, {
            "name": "cliqrWebServerType",
            "value": "tomcat6"
        }, {
            "name": "appMigrationFiles",
            "value": "cliqrWARFile,cliqrEARPath,cliqrPlanPath"
        }],
        "envParams": [{
            "name": "appPackage",
            "value": ""
        }, {
            "name": "cliqrWebappAccessLink",
            "value": ""
        }, {
            "name": "SharedStorageName",
            "value": "mystor"
        }, {
            "name": "OSSVC_HOME",
            "value": "/usr/local/osmosix/service"
        }, {
            "name": "cliqrTomcat6PostStartAction",
            "value": ""
        }, {
            "name": "cliqrWebappContext",
            "value": "ROOT"
        }, {
            "name": "cliqrExternalHttpEnabled",
            "value": "1"
        }, {
            "name": "cliqrTomcat6PostStopAction",
            "value": ""
        }, {
            "name": "cliqrDBDataStorageSize",
            "value": "0"
        }, {
            "name": "minClusterSize",
            "value": "1"
        }, {
            "name": "defaultService",
            "value": ""
        }, {
            "name": "cliqrSSLCert",
            "value": ""
        }, {
            "name": "launchVendorId",
            "value": "1"
        }, {
            "name": "cliqrSSLKey",
            "value": ""
        }, {
            "name": "cliqrWARFile",
            "value": "http://env.cliqrtech.com/jenkins/jenkins.war"
        }, {
            "name": "pathParamNames_app_34_order_0",
            "value": "cliqrWARFile,cliqrTomcat6PreStartAction,cliqrTomcat6PostStartAction,cliqrTomcat6PreStopAction,cliqrTomcat6PostStopAction,cliqrExternalPreStartAction,cliqrExternalPreInitAction,cliqrExternalPostStartAction,cliqrExternalPreStopAction,cliqrExternalPostStopAction,resumeScript"
        }, {
            "name": "cliqrExternalNoProtocolEnabled",
            "value": "0"
        }, {
            "name": "cliqrExternalPreStartAction",
            "value": ""
        }, {
            "name": "cliqrExternalHttpsEnabled",
            "value": "0"
        }, {
            "name": "launchUserName",
            "value": "cliqradmin"
        }, {
            "name": "bareMetalMachine",
            "value": "false"
        }, {
            "name": "cliqrNoOfVolumes",
            "value": "0"
        }, {
            "name": "cliqrNonStandardPort",
            "value": ""
        }, {
            "name": "maxClusterSize",
            "value": "3"
        }, {
            "name": "cliqrJDKVersion",
            "value": "JDK6"
        }, {
            "name": "cliqrWebappConfigFiles",
            "value": ""
        }, {
            "name": "cliqrTomcat6PreStartAction",
            "value": ""
        }, {
            "name": "NumNodes",
            "value": "1"
        }, {
            "name": "cliqrForceHttpRedirect",
            "value": "0"
        }, {
            "name": "SharedStorageMount",
            "value": "/shared"
        }, {
            "name": "resumeScript",
            "value": ""
        }, {
            "name": "TopologyNodeParams",
            "value": "{\"x\":\"150\",\"y\":\"120\"}"
        }, {
            "name": "cliqrIgnoreAppFailure",
            "value": "true"
        }, {
            "name": "tierOrder",
            "value": "1"
        }, {
            "name": "cliqrPlanPath",
            "value": ""
        }, {
            "name": "cliqrUseCustomCert",
            "value": "0"
        }, {
            "name": "cliqrTomcat6PreStopAction",
            "value": ""
        }, {
            "name": "cliqrAppType",
            "value": "defaultApp"
        }, {
            "name": "cliqrExternalPostStartAction",
            "value": ""
        }, {
            "name": "cloudConfigFilePath",
            "value": "/root/venkat.txt"
        }, {
            "name": "pathParamNames_app_33_order_0",
            "value": "appPackage"
        }, {
            "name": "cloudConfigFileContents",
            "value": "%NIC1_IP%\n%NIC2_IP%\n%NIC3_IP%\n\nIP Addresses:  %NIC1_IP%  , %NIC2_IP%  ,\n%NIC3_IP% "
        }, {
            "name": "topTier",
            "value": "true"
        }, {
            "name": "cliqrExternalPreInitAction",
            "value": ""
        }, {
            "name": "microSegmentation",
            "value": "0"
        }, {
            "name": "cliqrAppName",
            "value": "WebServer"
        }, {
            "name": "cliqrExternalPostStopAction",
            "value": ""
        }, {
            "name": "CliqrDepEnvName",
            "value": "Venkat-Deploy-Env1"
        }, {
            "name": "cliqrExternalPreStopAction",
            "value": ""
        }, {
            "name": "launchUserId",
            "value": "2"
        }, {
            "name": "CliqrDepEnvId",
            "value": "1"
        }, {
            "name": "cliqrEARPath",
            "value": ""
        }, {
            "name": "OSSVC_CONFIG",
            "value": "tomcat6"
        }, {
            "name": "useNonStandardPort",
            "value": "0"
        }, {
            "name": "launchIdent",
            "value": "{user}cliqradmin{group}{vendor}1"
        }, {
            "name": "cliqrWebServerType",
            "value": "tomcat6"
        }, {
            "name": "appMigrationFiles",
            "value": "cliqrWARFile,cliqrEARPath,cliqrPlanPath"
        }],
        "nodeParams": []
    },
    "virtualMachines": [],
    "approvalRequest": {
        "currentDeploymentEnvironment": {
            "id": "",
            "resource": ""
        },
        "fromDeploymentEnvironment": {
            "id": "",
            "resource": ""
        },
        "initiatingUser": {
            "id": "",
            "resource": ""
        },
        "approvingUser": {
            "id": "",
            "resource": ""
        },
        "requestTime": "",
        "approvalTime": "",
        "status": "AUTO_APPROVED",
        "message": ""
    },
    "childJobs": [],
    "tags": [],
    "policyIds": [],
    "securityProfiles": [],
    "windowsJob": false,
    "scalable": true,
    "metadata": []
}

Example 3 – Child Job includeNodeDetails=true&includeNodeCostDetails=true&includeNodeTaskDetails=true 

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs/112?includeNodeDetails=true&includeNodeCostDetails=true&includeNodeTaskDetails=true"
  • Details for a child job are not displayed in the parent job details. Instead, use the child job link to view details for the child job.
  • Correspondingly, each child job contains a link back to the parent job.

Response

 Click here to expand...
{
    "id": "8040",
    "resource": "https://<HOST>:<PORT>/v2/jobs/8040?includeNodeDetails=true&includeNodeCostDetails=true&includeNodeTaskDetails=true",
    "name": "tomcat6_0",
    "description": "",
    "status": "JobRunning",
    "jobStatusMessage": "",
    "startTime": "1503689247821",
    "endTime": "",
    "favoriteCreationTime": "",
    "cloudFamily": "Amazon",
    "deploymentEnvironment": {
        "id": "",
        "resource": ""
    },
    "application": {
        "id": "302",
        "version": "1.54",
        "resource": "https://<HOST>:<PORT>/v1/apps/302?version=1.54"
    },
    "actions": ["SCALE_UP", "SCALE_DOWN", "UPDATE_TAGS"],
    "terminateProtection": false,
    "hidden": false,
    "favorite": false,
    "benchmark": false,
    "owner": true,
    "ownerEmailAddress": "vipoojar@cisco.com",
    "customActions": [],
    "parentJob": {
        "id": "8039",
        "resource": "https://<HOST>:<PORT>/v2/jobs/8039"
    },
    "lastUpdatedTime": "1503689861986",
    "bareMetalMachines": [],
    "accessLink": "",
    "parameters": {
        "cloudParams": {
            "cloudRegionId": 8,
            "instance": "m1.small",
            "instanceName": "m1.small",
            "nics": [{
                "id": "subnet-5de4ae75",
                "type": "NETWORK",
                "allocationMode": "DHCP",
                "order": 1,
                "allocatePublicIp": true,
                "properties": [],
                "netId": null
            }],
            "volumes": [],
            "provisionBareMetal": false,
            "deploymentIsolationTag": "",
            "autoCloudAndInstanceSelection": false,
            "selectionCriteria": "NONE",
            "accountId": "46",
            "rootVolumeSize": "",
            "storage": "",
            "networkTypeName": "",
            "cloudProperties": [{
                "name": "cloud",
                "value": "Amazon-us-east-1"
            }, {
                "name": "subnetId",
                "value": "subnet-5de4ae75"
            }, {
                "name": "CloudFamily",
                "value": "Amazon"
            }, {
                "name": "SSHPreference",
                "value": "NO_PREFERENCE"
            }, {
                "name": "vpcId",
                "value": "vpc-2d827248"
            }, {
                "name": "numNICs",
                "value": "1"
            }]
        },
        "appParams": [{
            "name": "appPackage",
            "value": ""
        }, {
            "name": "cliqrWebappAccessLink",
            "value": ""
        }, {
            "name": "SharedStorageName",
            "value": "mystor"
        }, {
            "name": "OSSVC_HOME",
            "value": "/usr/local/osmosix/service"
        }, {
            "name": "cliqrTomcat6PostStartAction",
            "value": ""
        }, {
            "name": "cliqrWebappContext",
            "value": "ROOT"
        }, {
            "name": "cliqrExternalHttpEnabled",
            "value": "1"
        }, {
            "name": "cliqrTomcat6PostStopAction",
            "value": ""
        }, {
            "name": "cliqrDBDataStorageSize",
            "value": "0"
        }, {
            "name": "minClusterSize",
            "value": "1"
        }, {
            "name": "defaultService",
            "value": ""
        }, {
            "name": "TestDeploymentParam",
            "value": "TestDeploymentParam"
        }, {
            "name": "pathParamNames_app_301_order_0",
            "value": "appPackage"
        }, {
            "name": "cliqrSSLCert",
            "value": ""
        }, {
            "name": "launchVendorId",
            "value": "28"
        }, {
            "name": "cliqrSSLKey",
            "value": ""
        }, {
            "name": "cliqrWARFile",
            "value": "%REPO_ID_32%apps/jenkins/jenkins.war"
        }, {
            "name": "cliqrExternalNoProtocolEnabled",
            "value": "0"
        }, {
            "name": "cliqrExternalPreStartAction",
            "value": ""
        }, {
            "name": "cliqrExternalHttpsEnabled",
            "value": "0"
        }, {
            "name": "launchUserName",
            "value": "vipoojar_M"
        }, {
            "name": "bareMetalMachine",
            "value": "false"
        }, {
            "name": "cliqrNoOfVolumes",
            "value": "0"
        }, {
            "name": "cliqrNonStandardPort",
            "value": ""
        }, {
            "name": "maxClusterSize",
            "value": "2"
        }, {
            "name": "cliqrJDKVersion",
            "value": "JDK6"
        }, {
            "name": "cliqrWebappConfigFiles",
            "value": ""
        }, {
            "name": "parentJobName",
            "value": "Jenkins_TviUA_20170825_001"
        }, {
            "name": "cliqrTomcat6PreStartAction",
            "value": ""
        }, {
            "name": "NumNodes",
            "value": "1"
        }, {
            "name": "cliqrForceHttpRedirect",
            "value": "0"
        }, {
            "name": "SharedStorageMount",
            "value": "/shared"
        }, {
            "name": "resumeScript",
            "value": ""
        }, {
            "name": "suspendScript",
            "value": ""
        }, {
            "name": "TopologyNodeParams",
            "value": "{\"x\":\"160\",\"y\":\"160\"}"
        }, {
            "name": "cliqrIgnoreAppFailure",
            "value": "false"
        }, {
            "name": "tierOrder",
            "value": "1"
        }, {
            "name": "cliqrPlanPath",
            "value": ""
        }, {
            "name": "cliqrUseCustomCert",
            "value": "0"
        }, {
            "name": "cliqrTomcat6PreStopAction",
            "value": ""
        }, {
            "name": "cliqrAppTierName",
            "value": "tomcat6_0"
        }, {
            "name": "pathParamNames_app_302_order_0",
            "value": "cliqrWARFile,cliqrTomcat6PreStartAction,cliqrTomcat6PostStartAction,cliqrTomcat6PreStopAction,cliqrTomcat6PostStopAction,cliqrExternalPreStartAction,cliqrExternalPreInitAction,cliqrExternalPostStartAction,cliqrExternalPreStopAction,cliqrExternalPostStopAction,suspendScript,resumeScript"
        }, {
            "name": "referredJob",
            "value": ""
        }, {
            "name": "cliqrAppType",
            "value": "defaultApp"
        }, {
            "name": "cliqrExternalPostStartAction",
            "value": ""
        }, {
            "name": "SSHPreference",
            "value": "NO_PREFERENCE"
        }, {
            "name": "topTier",
            "value": "true"
        }, {
            "name": "cliqrExternalPreInitAction",
            "value": ""
        }, {
            "name": "microSegmentation",
            "value": "0"
        }, {
            "name": "cliqrAppName",
            "value": "tomcat6_0"
        }, {
            "name": "cliqrExternalPostStopAction",
            "value": ""
        }, {
            "name": "sshUserName",
            "value": "cliqruser"
        }, {
            "name": "CliqrDepEnvName",
            "value": "AWS only"
        }, {
            "name": "cliqrExternalPreStopAction",
            "value": ""
        }, {
            "name": "launchUserId",
            "value": "48"
        }, {
            "name": "GREET",
            "value": "HELLO"
        }, {
            "name": "CliqrDepEnvId",
            "value": "65"
        }, {
            "name": "cliqrEARPath",
            "value": ""
        }, {
            "name": "OSSVC_CONFIG",
            "value": "tomcat6"
        }, {
            "name": "useNonStandardPort",
            "value": "0"
        }, {
            "name": "launchIdent",
            "value": "{user}vipoojar_M{group}Tenent-owner{vendor}28"
        }, {
            "name": "cliqrWebServerType",
            "value": "tomcat6"
        }, {
            "name": "appMigrationFiles",
            "value": "cliqrWARFile,cliqrEARPath,cliqrPlanPath"
        }],
        "envParams": [{
            "name": "appPackage",
            "value": ""
        }, {
            "name": "cliqrWebappAccessLink",
            "value": ""
        }, {
            "name": "SharedStorageName",
            "value": "mystor"
        }, {
            "name": "OSSVC_HOME",
            "value": "/usr/local/osmosix/service"
        }, {
            "name": "cliqrTomcat6PostStartAction",
            "value": ""
        }, {
            "name": "cliqrWebappContext",
            "value": "ROOT"
        }, {
            "name": "cliqrExternalHttpEnabled",
            "value": "1"
        }, {
            "name": "cliqrTomcat6PostStopAction",
            "value": ""
        }, {
            "name": "cliqrDBDataStorageSize",
            "value": "0"
        }, {
            "name": "minClusterSize",
            "value": "1"
        }, {
            "name": "defaultService",
            "value": ""
        }, {
            "name": "TestDeploymentParam",
            "value": "TestDeploymentParam"
        }, {
            "name": "pathParamNames_app_301_order_0",
            "value": "appPackage"
        }, {
            "name": "cliqrSSLCert",
            "value": ""
        }, {
            "name": "launchVendorId",
            "value": "28"
        }, {
            "name": "cliqrSSLKey",
            "value": ""
        }, {
            "name": "cliqrWARFile",
            "value": "%REPO_ID_32%apps/jenkins/jenkins.war"
        }, {
            "name": "cliqrExternalNoProtocolEnabled",
            "value": "0"
        }, {
            "name": "cliqrExternalPreStartAction",
            "value": ""
        }, {
            "name": "cliqrExternalHttpsEnabled",
            "value": "0"
        }, {
            "name": "launchUserName",
            "value": "vipoojar_M"
        }, {
            "name": "imageName",
            "value": "CentOS 6.x"
        }, {
            "name": "bareMetalMachine",
            "value": "false"
        }, {
            "name": "cliqrNoOfVolumes",
            "value": "0"
        }, {
            "name": "cliqrNonStandardPort",
            "value": ""
        }, {
            "name": "maxClusterSize",
            "value": "2"
        }, {
            "name": "cliqrJDKVersion",
            "value": "JDK6"
        }, {
            "name": "cliqrWebappConfigFiles",
            "value": ""
        }, {
            "name": "parentJobName",
            "value": "Jenkins_TviUA_20170825_001"
        }, {
            "name": "cliqrTomcat6PreStartAction",
            "value": ""
        }, {
            "name": "NumNodes",
            "value": "1"
        }, {
            "name": "cliqrForceHttpRedirect",
            "value": "0"
        }, {
            "name": "JOB_ID",
            "value": "8040"
        }, {
            "name": "SharedStorageMount",
            "value": "/shared"
        }, {
            "name": "resumeScript",
            "value": ""
        }, {
            "name": "suspendScript",
            "value": ""
        }, {
            "name": "TopologyNodeParams",
            "value": "{\"x\":\"160\",\"y\":\"160\"}"
        }, {
            "name": "cliqrIgnoreAppFailure",
            "value": "false"
        }, {
            "name": "tierOrder",
            "value": "1"
        }, {
            "name": "cliqrPlanPath",
            "value": ""
        }, {
            "name": "cliqrUseCustomCert",
            "value": "0"
        }, {
            "name": "cliqrTomcat6PreStopAction",
            "value": ""
        }, {
            "name": "cliqrAppTierName",
            "value": "tomcat6_0"
        }, {
            "name": "pathParamNames_app_302_order_0",
            "value": "cliqrWARFile,cliqrTomcat6PreStartAction,cliqrTomcat6PostStartAction,cliqrTomcat6PreStopAction,cliqrTomcat6PostStopAction,cliqrExternalPreStartAction,cliqrExternalPreInitAction,cliqrExternalPostStartAction,cliqrExternalPreStopAction,cliqrExternalPostStopAction,suspendScript,resumeScript"
        }, {
            "name": "referredJob",
            "value": ""
        }, {
            "name": "cliqrAppType",
            "value": "defaultApp"
        }, {
            "name": "cliqrExternalPostStartAction",
            "value": ""
        }, {
            "name": "SSHPreference",
            "value": "NO_PREFERENCE"
        }, {
            "name": "topTier",
            "value": "true"
        }, {
            "name": "cliqrExternalPreInitAction",
            "value": ""
        }, {
            "name": "microSegmentation",
            "value": "0"
        }, {
            "name": "cliqrAppName",
            "value": "tomcat6_0"
        }, {
            "name": "cliqrExternalPostStopAction",
            "value": ""
        }, {
            "name": "CliqrDepEnvName",
            "value": "AWS only"
        }, {
            "name": "cliqrExternalPreStopAction",
            "value": ""
        }, {
            "name": "launchUserId",
            "value": "48"
        }, {
            "name": "GREET",
            "value": "HELLO"
        }, {
            "name": "CliqrDepEnvId",
            "value": "65"
        }, {
            "name": "osName",
            "value": "Linux"
        }, {
            "name": "cliqrEARPath",
            "value": ""
        }, {
            "name": "OSSVC_CONFIG",
            "value": "tomcat6"
        }, {
            "name": "useNonStandardPort",
            "value": "0"
        }, {
            "name": "launchIdent",
            "value": "{user}vipoojar_M{group}Tenent-owner{vendor}28"
        }, {
            "name": "cliqrWebServerType",
            "value": "tomcat6"
        }, {
            "name": "appMigrationFiles",
            "value": "cliqrWARFile,cliqrEARPath,cliqrPlanPath"
        }],
        "nodeParams": [{
            "name": "x",
            "value": "160"
        }, {
            "name": "y",
            "value": "160"
        }]
    },
    "virtualMachines": [{
        "id": "i-0e66ca975c389a2a1",
        "virtualMachineId": "4987",
        "privateIpAddr": "172.31.45.68",
        "publicIpAddr": "54.160.8.173",
        "hostName": "ec2-54-160-8-173.compute-1.amazonaws.com",
        "zone": "us-east-1d",
        "status": "NodeReady",
        "startTime": "1503689297628",
        "endTime": "",
        "agentVersion": "V-4.8.1-20170813_1753",
        "nodeNetworkInterfaces": [{
            "privateIpAddr": "172.31.45.68",
            "publicIpAddr": "54.160.8.173",
            "networkDisplayName": "subnet-5de4ae75",
            "interfaceIndex": 0
        }],
        "costDetails": {
            "nodeId": "i-0e66ca975c389a2a1",
            "nodeHour": 1.6816667,
            "mgmtBillNodeHour": 1.6816667,
            "cloudBillNodeTime": 2.0,
            "cloudCostBillStartTime": "2017-08-25 19:28:17.628",
            "cloudCostBillEndTime": "2017-08-25 21:28:17.628",
            "recordTimestamp": "2017-08-25 20:09:02.27"
        },
        "taskDetails": [{
            "id": "154428",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_FINISHED",
            "lastUpdateTime": 1503689857473,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Success"
        }, {
            "id": "154427",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689857468,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Dependent services started successfully"
        }, {
            "id": "154426",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689855244,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Starting START services..."
        }, {
            "id": "154425",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689855231,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Dependent services configured successfully"
        }, {
            "id": "154424",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689853562,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Starting CONFIGURE services..."
        }, {
            "id": "154423",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689853546,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Dependent services deployed successfully"
        }, {
            "id": "154422",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689848200,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Starting dependent services..."
        }, {
            "id": "154421",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689848192,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Starting DEPLOY services..."
        }, {
            "id": "154420",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689848025,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Execute node setsudo: ALL"
        }, {
            "id": "154419",
            "taskId": "2147483644",
            "taskName": "nodeInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689838354,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Initializing cluster node..."
        }, {
            "id": "154413",
            "taskId": "2147483638",
            "taskName": "serviceInstall",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689568149,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Installing service.."
        }, {
            "id": "154412",
            "taskId": "2147483638",
            "taskName": "serviceInstall",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689533882,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Setting up custom repository.."
        }, {
            "id": "154411",
            "taskId": "2147483639",
            "taskName": "nodePreInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689523177,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Checking if cliqr tools are installed...  Yes"
        }, {
            "id": "154410",
            "taskId": "2147483639",
            "taskName": "nodePreInit",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689523177,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Pre initializing cluster node..."
        }, {
            "id": "154409",
            "taskId": "0",
            "taskName": "nodeBooting",
            "status": "TASK_RUNNING",
            "lastUpdateTime": 1503689296623,
            "nodeId": "i-0e66ca975c389a2a1",
            "msg": "Node booting up..."
        }],
        "properties": []
    }],
    "externalServiceInstance": null,
    "approvalRequest": {
        "currentDeploymentEnvironment": {
            "id": "",
            "resource": ""
        },
        "fromDeploymentEnvironment": {
            "id": "",
            "resource": ""
        },
        "initiatingUser": {
            "id": "",
            "resource": ""
        },
        "approvingUser": {
            "id": "",
            "resource": ""
        },
        "requestTime": "",
        "approvalTime": "",
        "status": "AUTO_APPROVED",
        "message": ""
    },
    "childJobs": [],
    "tags": [],
    "policyIds": [],
    "securityProfiles": [],
    "costDetails": {
        "nodeHours": 1.6816667,
        "billedNodeHours": 1.6816667,
        "cloudComputeCost": 0.088,
        "cloudStorageCost": 0.0,
        "appRunTimeCost": 0.0,
        "appServiceCost": 0.0,
        "nodeCostDetails": [{
            "nodeId": "i-0e66ca975c389a2a1",
            "nodeHour": 1.6816667,
            "mgmtBillNodeHour": 1.6816667,
            "cloudBillNodeTime": 2.0,
            "cloudCostBillStartTime": "1503689297628",
            "cloudCostBillEndTime": "1503696497628",
            "recordTimestamp": "1503691742270"
        }]
    },
    "windowsJob": false,
    "scalable": true,
    "metadata": []
}

Example 4 – Child Job Mapped to an External Service Tier using the query parameter, includeNodeDetails=true

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

Response

 Click here to expand...

You must first get job details for the parent job and then fetch the details for each child job using the includeNodeDetails=true query parameter. The external service details appear in the API once the service comes up.

{
   "id":"6889",
   "resource":"https://<HOST>:<PORT>/v2/jobs/6889?includeNodeDetails=true",
   "name":"dummyExternalService_1",
   "description":"",
   "status":"JobRunning",
   "jobStatusMessage":"",
   "startTime":"1500618315620",
   "endTime":"",
   "favoriteCreationTime":"",
   "cloudFamily":"Amazon",
   "deploymentEnvironment":{
      "id":"",
      "resource":""
   },
   "application":{
      "id":"300",
      "version":"1.0",
      "resource":"https://<HOST>:<PORT>/v1/apps/300?version=1.0"
   },
   "actions":[
      "UPDATE_TAGS"
   ],
   "terminateProtection":false,
   "hidden":false,
   "favorite":false,
   "benchmark":false,
   "owner":false,
   "ownerEmailAddress":"user.01@cc.com",
   "customActions":[

   ],
   "parentJob":{
      "id":"6888",
      "resource":"https://<HOST>:<PORT>/v2/jobs/6888"
   },
   "lastUpdatedTime":"1500618331377",
   "bareMetalMachines":[

   ],
   "accessLink":"",
   "parameters":{
      "cloudParams":{
         "cloudRegionId":8,
         "instance":"",
         "instanceName":"",
         "nics":[
            {
               "id":"subnet-5de4ae75",
               "type":"NETWORK",
               "allocationMode":"DHCP",
               "order":1,
               "allocatePublicIp":true,
               "properties":[

               ],
               "netId":null
            }
         ],
         "volumes":[

         ],
         "provisionBareMetal":false,
         "deploymentIsolationTag":"",
         "autoCloudAndInstanceSelection":false,
         "selectionCriteria":"NONE",
         "accountId":"46",
         "rootVolumeSize":"",
         "storage":"",
         "networkTypeName":"",
         "cloudProperties":[
            {
               "name":"cloud",
               "value":"Amazon-us-east-1"
            },
            {
               "name":"subnetId",
               "value":"subnet-5de4ae75"
            },
            {
               "name":"CloudFamily",
               "value":"Amazon"
            },
            {
               "name":"SSHPreference",
               "value":"NO_PREFERENCE"
            },
            {
               "name":"vpcId",
               "value":"vpc-2d827248"
            },
            {
               "name":"numNICs",
               "value":"1"
            }
         ]
      },
      "appParams":[
         {
            "name":"appPackage",
            "value":""
         },
         ...
         {
            "name":"cliqrCustomServiceType",
            "value":"dummyExternalService"
         }
      ],
      "envParams":[
         {
            "name":"appPackage",
            "value":""
         },
         ...
         {
            "name":"cliqrCustomServiceType",
            "value":"dummyExternalService"
         }
      ],
      "nodeParams":[
         {
            "name":"x",
            "value":"160"
         },
         {
            "name":"y",
            "value":"160"
         }
      ]
   },
   "virtualMachines":[

   ],
   "externalServiceInstance":{
      "id":"32",
      "serviceId":"68",
      "instanceName":"test_instance",
      "instanceType":"dummy",
      "serviceType":"custom",
      "productType":null,
      "status":"available",
      "hostName":"testsite",
      "ipAddress":"192.168.1.8",
      "startTime":"2017-07-21 06:25:30.278",
      "endTime":null,
      "costDetails":null
   },
   "approvalRequest":{
      "currentDeploymentEnvironment":{
         "id":"",
         "resource":""
      },
      "fromDeploymentEnvironment":{
         "id":"",
         "resource":""
      },
      "initiatingUser":{
         "id":"",
         "resource":""
      },
      "approvingUser":{
         "id":"",
         "resource":""
      },
      "requestTime":"",
      "approvalTime":"",
      "status":"AUTO_APPROVED",
      "message":""
   },
   "childJobs":[

   ],
   "tags":[

   ],
   "policyIds":[

   ],
   "securityProfiles":[

   ],
   "windowsJob":false,
   "scalable":false,
   "metadata":[

   ]
}

Request Attributes

Optional – Job Details Queries
 Optional query parameters

includeNodeDetails
  • Description: Identifies if VM (node) details like Private IP ( privateIpAddr), Public IP (publicIpAddr), NIC details (nicInfo), and so forth should be included in the response.
  • Type: Boolean
    • true = VM details are included.
    • false = Default. VM details are not included.

includeNodeCostDetails
  • Description: Identifies if VM (node) cost details like time stamp cost and so forth should be included in the response.
  • Type: Boolean
    • true = VM cost details are included.
    • false = Default. VM cost details are not included.

includeNodeTaskDetails
  • Description: Identifies if VM (node) task details are included in the response.
  • Type: Boolean
    • true = VM task details are included.
    • false = Default. VM task details are not included.

excludeNodeStatus
  • Description: Identifies the status (nodeStatus) to be excluded when displaying a list of node details. This could be for a single node status or a comma separated list of node statues. The acceptable values are all, NodeStarting, NodeStarted, NodeReady, NodeTerminated, NodeCleaned, NodeError, NodeNotReachable, NodeReachable, NodeSuspending, NodeSuspended, NodeResuming, and NodeResumed. See Deployment and VM States for additional context
  • 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
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 response attribute)
  • Type: String

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
startTime
endTime
favoriteCreationTime
  • Description: If the job was configured as a favorite job (see Deployments > Favorite Deployments for additional context), then this attribute identifies the time when this configuration took place.
  • 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 for more details)

deploymentEntity (click for more details)

This attribute is only applicable for the parent job.

 terminateProtection 
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
parentJob
  • Description: Information about the parent 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

lastUpdatedTime
  • Description: Date that this resource was last updated. This attribute is the same as the lastUpdated attribute.

  • Type: Long

bareMetalMachines (click for more details)

  • Description: If v2 API responses contain either container and N-Tier jobs, the CloudCenter platform provides an access link in the form of a defined URL.
  • Type: URL

parameters (click for more details)

virtualMachines (click for more details)

This attribute is only applicable for a child job.

externalServiceInstance (click for more details)

This attribute is only applicable for a child job.

approvalRequest (click for more details)

childJobs (click for more details)

tags
  • DescriptionTags associated with this resource. Each string represents a System Tag.

    If you filter reports based on tags that you applied to VMs or jobs, then the report displays all the VMs or jobs that have this exact combination of tags.

  • Type: Array of strings

policyIds
  • Description: A list of policies associated with the job.
  • Type: String
 securityProfiles 
  • Description: Identifies the associated security profile details for this job.

  • Type: Array of attributes for the request

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

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
windowsJob
  • Description: Identifies if this Windows based job.

    • true = This is a Windows-based job.
    • false = This is not a Windows-based job.
  • Type: Boolean

scalable
  • Description: Identifies if this resource is scalable.

    • true = Resource is scalable
    • false = Resource is not scalable
  • Type: Boolean

metadata
  • Description: Identifies the metadata associated with the job.
  • Type: Sequence of metadata details

    namespace
    • Description: Context-sensitive differentiation for the resource name.
    • Type: String

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

    • Type: String

    value
    • Description: Indicates the set value for this property
    • Type: Float
    editable
    • Description: Identifies if this resource is editable. This attribute is the same as the edit attribute.

    • Type: Boolean
      • true = Resource is editable
      • false = Resource is not editable

    required
    • Description: Identifies if this resource is required.

      • true = Resource is required
      • false = Resource is not required
    • Type: Boolean