Get Tier-Specific Log Details

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameGet Tier-Specific Log Details
Description

View all UI logs for each tier in an application profile deployment

Allowed Role(s)WM_USER
MethodGET
URI

job/service/get_job_info/jobId

cloudcenter-ccm-backend/api/job/service/get_job_info/jobId

Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://10.10.100.10/job/service/get_job_info/402" 
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://10.10.100.10/cloudcenter-ccm-backend/api/job/service/get_job_info/402" 
Release

Introduced in CloudCenter 4.0

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.
  • This API does not use v1 in the request URI.
  • For individual child tiers, issue this API using each child job ID and retrieve the job information and associated logs.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: get.service.get_job_info.jobId

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

Not applicable

Sample Response 1

{
   "statusSummary":{
      "userId":2,
      "jobId":402,
      "jobStatusSummaryId":{
         "userId":2,
         "jobId":402
      },
      "jobName":"aaa",
      "jobDesc":null,
      "templateName":"Jenkins",
      "templateId":93,
      "instanceType":null,
      "status":"JobSuspending",
      "deploymentStatus":"Suspending",
      "startTime":1533711632436,
      "endTime":null,
      "scheduleEndTime":null,
      "timeZone":"UTC",
      "lastUpdateTime":1533823842294,
      "webBenchHours":0.0,
      "version":"C6",
      "tag":null,
      "msg":"Job successfully scaled",
      "eventTime":1533823842294
   },
   "nodeStatus":null,
   "taskStatus":null,
   "globalParams":null,
   "nodeStatusSummary":{
      "NodeReady":0,
      "NodeLaunching":0,
      "NodeBooting":0,
      "NodeStarting":0,
      "NodeError":0
   },
   "envVars":[

   ],
   "appParams":[
      {
         "id":null,
         "paramName":"cliqrWebappAccessLink",
         "displayName":null,
         "helpText":null,
         "type":"string",
         "valueConstraint":null,
         "valueList":null,
         "collectionList":null,
         "linkedParams":null,
         "defaultValue":"",
         "confirmValue":"",
         "pathSuffixValue":"",
         "userVisible":true,
         "userEditable":true,
         "multiselectSupported":false,
         "useDefault":true,
         "systemParam":true,
         "exampleValue":null,
         "optional":false,
         "dataUnit":null,
         "scope":null,
         "webserviceListParams":null,
         "secret":null,
         "deploymentParam":false
      },
      {
         "id":null,
         "paramName":"cliqrExternalHttpsEnabled",
         "displayName":null,
         "helpText":null,
         "type":"string",
         "valueConstraint":null,
         "valueList":null,
         "collectionList":null,
         "linkedParams":null,
         "defaultValue":"0",
         "confirmValue":"",
         "pathSuffixValue":"",
         "userVisible":true,
         "userEditable":true,
         "multiselectSupported":false,
         "useDefault":true,
         "systemParam":true,
         "exampleValue":null,
         "optional":false,
         "dataUnit":null,
         "scope":null,
         "webserviceListParams":null,
         "secret":null,
         "deploymentParam":false
      },
      ...
      {
         "id":null,
         "paramName":"cliqrSSLKey",
         "displayName":"SSL Key location",
         "helpText":null,
         "type":null,
         "valueConstraint":null,
         "valueList":null,
         "collectionList":null,
         "linkedParams":null,
         "defaultValue":"",
         "confirmValue":"",
         "pathSuffixValue":"",
         "userVisible":false,
         "userEditable":false,
         "multiselectSupported":false,
         "useDefault":true,
         "systemParam":true,
         "exampleValue":null,
         "optional":false,
         "dataUnit":null,
         "scope":null,
         "webserviceListParams":null,
         "secret":null,
         "deploymentParam":false
      }
   ],
   "jobRuntimeTags":[
      {
         "id":292,
         "namespace":"",
         "tagName":"META_EDIT",
         "tagCollectionId":183,
         "value":"Editable",
         "required":false,
         "editable":true
      },
      {
         "id":293,
         "namespace":"",
         "tagName":"META_MAND",
         "tagCollectionId":183,
         "value":"Mandatory",
         "required":true,
         "editable":false
      },
      {
         "id":294,
         "namespace":"",
         "tagName":"META_MAND_EDIT",
         "tagCollectionId":183,
         "value":"Mandatory and Editable",
         "required":true,
         "editable":true
      },
      {
         "id":295,
         "namespace":"",
         "tagName":"Name",
         "tagCollectionId":183,
         "value":"aaa",
         "required":true,
         "editable":false
      }
   ],
   "publicIPAddress":null,
   "cloudInstanceType":null,
   "cloudType":"aws-us-east-1",
   "cloudName":"aws US East (Virginia)",
   "cloudFamily":"Amazon",
   "executorBean":"NTierExecutor",
   "depEnvName":"aws",
   "depEnvId":"3",
   "approvalRequestStatus":"",
   "approvalCategory":"",
   "approvalRequestAction":"",
   "agingPolicyName":null,
   "scalingPolicyName":null,
   "nodeStatusDefinitioname":null,
   "agingPolicy":{
      "id":"1",
      "resource":"https://<HOST>:<PORT>/v2/agingPolicies/1",
      "perms":[
         "administration"
      ],
      "name":"DemoAging",
      "description":"",
      "enabled":true,
      "sharedToSubTenants":true,
      "type":"COST",
      "vendorName":"Cisco Systems",
      "limit":{
         "amount":1200,
         "unit":"USD"
      },
      "terminateWhenPolicyEnds":true,
      "allowGracePeriodForTermination":true,
      "graceLimit":{
         "amount":5,
         "unit":"DAYS"
      },
      "allowPolicyExtension":false,
      "extensionLimit":null,
      "allowGracePeriodNotification":false,
      "allowPolicyExpiryNotification":false,
      "notifications":[

      ],
      "isPolicyActiveOnResources":true,
      "created":1532401621252,
      "lastUpdated":1532401621252,
      "resources":[
         {
            "resourceId":"402",
            "resourceType":"JOB",
            "appliedDate":1533814948215,
            "resourceStartTime":1533711632436,
            "estimatedPolicyEndTime":null,
            "allowedTime":null,
            "allowedCost":1200,
            "accruedCost":1.3813152313232422,
            "numberOfExtensionsUsed":0,
            "isApprovalPending":false,
            "isPreviousExtensionDenied":false,
            "isPolicyReachingExpiry":false,
            "isPolicyReachingGraceExpiry":false,
            "extensionHistories":[

            ]
         }
      ]
   },
   "suspensionPolicy":null,
   "totalCost":1.3813152,
   "type":"web",
   "sourceAppId":93,
   "serviceId":null,
   "serviceType":null,
   "rootAppId":93,
   "approvalRequestJaxb":{
      "id":null,
      "resource":null,
      "devEnvName":null,
      "fromDevEnvName":null,
      "initiatingUser":"Cliqr (admin@cliqrtech.com)",
      "lastApprovalInitiatingUser":null,
      "approvingUser":"Cliqr (admin@cliqrtech.com)",
      "lastApprovalAction":"Deployment",
      "requestTime":"1533711620836",
      "approvalTime":"1533711620836",
      "approvalStatus":"AUTO_APPROVED",
      "message":"Auto-Approved"
   },
   "sshAllowed":true,
   "vmActionAllowed":true,
   "chargeType":"Hourly",
   "childJobDetails":[
      {
         "statusSummary":{
            "userId":2,
            "jobId":403,
            "jobStatusSummaryId":{
               "userId":2,
               "jobId":403
            },
            "jobName":"FrontendCache",
            "jobDesc":null,
            "templateName":"FrontendCache",
            "templateId":94,
            "instanceType":"t2.micro",
            "status":"JobRunning",
            "deploymentStatus":null,
            "startTime":1533711662241,
            "endTime":null,
            "scheduleEndTime":null,
            "timeZone":"UTC",
            "lastUpdateTime":1533741949356,
            "webBenchHours":0.0,
            "version":"C6",
            "tag":null,
            "msg":null,
            "eventTime":1533741949356
         },
         "nodeStatus":null,
         "taskStatus":null,
         "globalParams":null,
         "nodeStatusSummary":{
            "NodeReady":1,
            "NodeLaunching":0,
            "NodeBooting":0,
            "NodeStarting":0,
            "NodeError":0
         },
         "envVars":[
            {
               "id":221,
               "name":"ENV_PARAM_HIDDEN",
               "value":"Hidden",
               "userVisible":false,
               "userEditable":false
            },
            {
               "id":222,
               "name":"ENV_PARAM_VISIBLE",
               "value":"Visible Only",
               "userVisible":true,
               "userEditable":false
            },
            {
               "id":223,
               "name":"ENV_PARAM_EDITABLE",
               "value":"Visible and Editable",
               "userVisible":true,
               "userEditable":true
            },
            {
               "id":224,
               "name":"ENV_PARAM_OPTIONAL",
               "value":"Optional",
               "userVisible":true,
               "userEditable":true
            }
         ],
         "appParams":[
            {
               "id":null,
               "paramName":"cliqrFrontendCacheType",
               "displayName":null,
               "helpText":null,
               "type":"string",
               "valueConstraint":null,
               "valueList":null,
               "collectionList":null,
               "linkedParams":null,
               "defaultValue":"varnish",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":false,
               "userEditable":false,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":true,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            },
            ...
            {
               "id":null,
               "paramName":"TIER_PARAM_TEXT",
               "displayName":"TIER_PARAM_TEXT",
               "helpText":"TIER_PARAM_TEXT",
               "type":"textarea",
               "valueConstraint":{
                  "minValue":0,
                  "maxValue":0,
                  "maxLength":255,
                  "regex":null,
                  "allowSpaces":true,
                  "sizeValue":0,
                  "step":0,
                  "calloutWorkflowName":null
               },
               "valueList":null,
               "collectionList":[

               ],
               "linkedParams":null,
               "defaultValue":"I @m a Tier T3xt Area with `~!@#$%^&-_=+[]{};:'\"\\,.<>/?\":;",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":true,
               "userEditable":true,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":false,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            }
         ],
         "jobRuntimeTags":null,
         "publicIPAddress":null,
         "cloudInstanceType":{
            "id":60,
            "cloudType":"aws-us-east-1",
            "instanceType":"t2.micro",
            "name":"t2.micro",
            "description":"General Purpose - Current Generation",
            "costPerHour":0.0116,
            "costPerHourPreferredCurrency":0.0,
            "hwSpec":{
               "memorySize":1024,
               "numOfCPUs":1,
               "cpuUnit":null,
               "numOfNICs":2,
               "localStorageCount":0,
               "localStorageSize":0,
               "cudaSupport":false,
               "ssdSupport":false,
               "supportHardwareProvision":false,
               "supportsPremiumStorage":false,
               "other":{

               }
            },
            "swSpec":{
               "support32bit":true,
               "support64bit":true,
               "support32On64":false,
               "osName":null
            },
            "displayCategory":null,
            "dummy":false,
            "deleted":false
         },
         "cloudType":"aws-us-east-1",
         "cloudName":"aws US East (Virginia)",
         "cloudFamily":"Amazon",
         "executorBean":"ChildTierAppExecutor",
         "depEnvName":"aws",
         "depEnvId":"3",
         "approvalRequestStatus":"",
         "approvalCategory":"",
         "approvalRequestAction":"",
         "agingPolicyName":null,
         "scalingPolicyName":null,
         "nodeStatusDefinitioname":null,
         "agingPolicy":null,
         "suspensionPolicy":null,
         "totalCost":0.3593648,
         "type":"leaf",
         "sourceAppId":94,
         "serviceId":6,
         "serviceType":"VM_AGENT",
         "rootAppId":93,
         "approvalRequestJaxb":{
            "id":null,
            "resource":null,
            "devEnvName":null,
            "fromDevEnvName":null,
            "initiatingUser":"Cliqr (admin@cliqrtech.com)",
            "lastApprovalInitiatingUser":null,
            "approvingUser":"Cliqr (admin@cliqrtech.com)",
            "lastApprovalAction":"Deployment",
            "requestTime":"1533711620836",
            "approvalTime":"1533711620836",
            "approvalStatus":"AUTO_APPROVED",
            "message":"Auto-Approved"
         },
         "sshAllowed":true,
         "vmActionAllowed":true,
         "chargeType":"Hourly",
         "childJobDetails":[

         ],
         "dependentStepNames":[
            "LoadBalancer"
         ],
         "securityProfileNames":[

         ],
         "nodeParams":{
            "x":"40",
            "y":"60"
         },
         "cloudSettings":{
            "cloud":"aws-us-east-1",
            "subnetId":"subnet-1fafee46",
            "CloudFamily":"Amazon",
            "accountDisplayName":"awsaccount",
            "nicInfo":"[{\"privateIPAllocationMode\":\"DHCP\",\"nicNetworkType\":\"NETWORK\",\"networkID\":\"subnet-1fafee46\",\"order\":1,\"publicIpAllocate\":true}]",
            "vpcId":"vpc-3e41595b",
            "numNICs":"1"
         },
         "storageJobName":null,
         "storageIp":null,
         "projectName":null,
         "phaseName":null,
         "phaseId":null,
         "projectId":null,
         "parentJobId":402,
         "parentJobName":"aaa",
         "logoPath":null,
         "jobMinimumNodeCount":1,
         "numNodes":1,
         "networkServices":null,
         "namespace":null,
         "labels":null,
         "referredJob":null,
         "referredJobName":null,
         "referredJobAccess":null,
         "preventTermination":false
      },
      {
         "statusSummary":{
            "userId":2,
            "jobId":404,
            "jobStatusSummaryId":{
               "userId":2,
               "jobId":404
            },
            "jobName":"LoadBalancer",
            "jobDesc":null,
            "templateName":"LoadBalancer",
            "templateId":95,
            "instanceType":"t2.micro",
            "status":"JobRunning",
            "deploymentStatus":null,
            "startTime":1533711681997,
            "endTime":null,
            "scheduleEndTime":null,
            "timeZone":"UTC",
            "lastUpdateTime":1533729450335,
            "webBenchHours":0.0,
            "version":"C6",
            "tag":null,
            "msg":null,
            "eventTime":1533729450335
         },
         "nodeStatus":null,
         "taskStatus":null,
         "globalParams":null,
         "nodeStatusSummary":{
            "NodeReady":1,
            "NodeLaunching":0,
            "NodeBooting":0,
            "NodeStarting":0,
            "NodeError":0
         },
         "envVars":[
            {
               "id":225,
               "name":"ENV_PARAM_HIDDEN",
               "value":"Hidden",
               "userVisible":false,
               "userEditable":false
            },
            {
               "id":226,
               "name":"ENV_PARAM_VISIBLE",
               "value":"Visible Only",
               "userVisible":true,
               "userEditable":false
            },
            {
               "id":227,
               "name":"ENV_PARAM_EDITABLE",
               "value":"Visible and Editable",
               "userVisible":true,
               "userEditable":true
            },
            {
               "id":228,
               "name":"ENV_PARAM_OPTIONAL",
               "value":"Optional",
               "userVisible":true,
               "userEditable":true
            }
         ],
         "appParams":[
            {
               "id":null,
               "paramName":"cliqrLoadBalancerType",
               "displayName":null,
               "helpText":null,
               "type":"string",
               "valueConstraint":null,
               "valueList":null,
               "collectionList":null,
               "linkedParams":null,
               "defaultValue":"nginx",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":false,
               "userEditable":false,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":true,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            },
            ...
            {
               "id":null,
               "paramName":"serviceTypeParam",
               "displayName":"Parameter for service config for this tier",
               "helpText":null,
               "type":null,
               "valueConstraint":null,
               "valueList":null,
               "collectionList":null,
               "linkedParams":null,
               "defaultValue":"cliqrLoadBalancerType",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":false,
               "userEditable":false,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":true,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            }
         ],
         "jobRuntimeTags":null,
         "publicIPAddress":null,
         "cloudInstanceType":{
            "id":60,
            "cloudType":"aws-us-east-1",
            "instanceType":"t2.micro",
            "name":"t2.micro",
            "description":"General Purpose - Current Generation",
            "costPerHour":0.0116,
            "costPerHourPreferredCurrency":0.0,
            "hwSpec":{
               "memorySize":1024,
               "numOfCPUs":1,
               "cpuUnit":null,
               "numOfNICs":2,
               "localStorageCount":0,
               "localStorageSize":0,
               "cudaSupport":false,
               "ssdSupport":false,
               "supportHardwareProvision":false,
               "supportsPremiumStorage":false,
               "other":{

               }
            },
            "swSpec":{
               "support32bit":true,
               "support64bit":true,
               "support32On64":false,
               "osName":null
            },
            "displayCategory":null,
            "dummy":false,
            "deleted":false
         },
         "cloudType":"aws-us-east-1",
         "cloudName":"aws US East (Virginia)",
         "cloudFamily":"Amazon",
         "executorBean":"ChildTierAppExecutor",
         "depEnvName":"aws",
         "depEnvId":"3",
         "approvalRequestStatus":"",
         "approvalCategory":"",
         "approvalRequestAction":"",
         "agingPolicyName":null,
         "scalingPolicyName":null,
         "nodeStatusDefinitioname":null,
         "agingPolicy":null,
         "suspensionPolicy":null,
         "totalCost":0.3592971,
         "type":"leaf",
         "sourceAppId":95,
         "serviceId":12,
         "serviceType":"VM_AGENT",
         "rootAppId":93,
         "approvalRequestJaxb":{
            "id":null,
            "resource":null,
            "devEnvName":null,
            "fromDevEnvName":null,
            "initiatingUser":"Cliqr (admin@cliqrtech.com)",
            "lastApprovalInitiatingUser":null,
            "approvingUser":"Cliqr (admin@cliqrtech.com)",
            "lastApprovalAction":"Deployment",
            "requestTime":"1533711620836",
            "approvalTime":"1533711620836",
            "approvalStatus":"AUTO_APPROVED",
            "message":"Auto-Approved"
         },
         "sshAllowed":true,
         "vmActionAllowed":true,
         "chargeType":"Hourly",
         "childJobDetails":[

         ],
         "dependentStepNames":[
            "AppServer"
         ],
         "securityProfileNames":[

         ],
         "nodeParams":{
            "x":"40",
            "y":"200"
         },
         "cloudSettings":{
            "cloud":"aws-us-east-1",
            "subnetId":"subnet-1fafee46",
            "CloudFamily":"Amazon",
            "accountDisplayName":"awsaccount",
            "nicInfo":"[{\"privateIPAllocationMode\":\"DHCP\",\"nicNetworkType\":\"NETWORK\",\"networkID\":\"subnet-1fafee46\",\"order\":1,\"publicIpAllocate\":true}]",
            "vpcId":"vpc-3e41595b",
            "numNICs":"1"
         },
         "storageJobName":null,
         "storageIp":null,
         "projectName":null,
         "phaseName":null,
         "phaseId":null,
         "projectId":null,
         "parentJobId":402,
         "parentJobName":"aaa",
         "logoPath":null,
         "jobMinimumNodeCount":1,
         "numNodes":1,
         "networkServices":null,
         "namespace":null,
         "labels":null,
         "referredJob":null,
         "referredJobName":null,
         "referredJobAccess":null,
         "preventTermination":false
      },
      {
         "statusSummary":{
            "userId":2,
            "jobId":405,
            "jobStatusSummaryId":{
               "userId":2,
               "jobId":405
            },
            "jobName":"AppServer",
            "jobDesc":null,
            "templateName":"AppServer",
            "templateId":96,
            "instanceType":"t2.micro",
            "status":"JobRunning",
            "deploymentStatus":null,
            "startTime":1533711636471,
            "endTime":null,
            "scheduleEndTime":null,
            "timeZone":"UTC",
            "lastUpdateTime":1533767468245,
            "webBenchHours":0.0,
            "version":"C6",
            "tag":null,
            "msg":"Job successfully scaled",
            "eventTime":1533767468245
         },
         "nodeStatus":null,
         "taskStatus":null,
         "globalParams":null,
         "nodeStatusSummary":{
            "NodeReady":2,
            "NodeLaunching":0,
            "NodeBooting":0,
            "NodeStarting":0,
            "NodeError":0
         },
         "envVars":[
            {
               "id":229,
               "name":"ENV_PARAM_HIDDEN",
               "value":"Hidden",
               "userVisible":false,
               "userEditable":false
            },
            {
               "id":230,
               "name":"ENV_PARAM_VISIBLE",
               "value":"Visible Only",
               "userVisible":true,
               "userEditable":false
            },
            {
               "id":231,
               "name":"ENV_PARAM_EDITABLE",
               "value":"Visible and Editable",
               "userVisible":true,
               "userEditable":true
            },
            {
               "id":232,
               "name":"ENV_PARAM_OPTIONAL",
               "value":"Optional",
               "userVisible":true,
               "userEditable":true
            }
         ],
         "appParams":[
            {
               "id":null,
               "paramName":"cliqrWebServerType",
               "displayName":null,
               "helpText":null,
               "type":"string",
               "valueConstraint":null,
               "valueList":null,
               "collectionList":null,
               "linkedParams":null,
               "defaultValue":"tomcat6",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":false,
               "userEditable":false,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":true,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            },
            ...
            {
               "id":null,
               "paramName":"maxAppClusterSize",
               "displayName":"Maximum number of nodes",
               "helpText":null,
               "type":null,
               "valueConstraint":null,
               "valueList":null,
               "collectionList":null,
               "linkedParams":null,
               "defaultValue":"2",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":false,
               "userEditable":false,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":true,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            },
            {
               "id":null,
               "paramName":"serviceTypeParam",
               "displayName":"Parameter name for service config for this tier",
               "helpText":null,
               "type":null,
               "valueConstraint":null,
               "valueList":null,
               "collectionList":null,
               "linkedParams":null,
               "defaultValue":"cliqrAppContainerType",
               "confirmValue":"",
               "pathSuffixValue":"",
               "userVisible":false,
               "userEditable":false,
               "multiselectSupported":false,
               "useDefault":true,
               "systemParam":true,
               "exampleValue":null,
               "optional":false,
               "dataUnit":null,
               "scope":null,
               "webserviceListParams":null,
               "secret":null,
               "deploymentParam":false
            }
         ],
         "jobRuntimeTags":null,
         "publicIPAddress":null,
         "cloudInstanceType":{
            "id":60,
            "cloudType":"aws-us-east-1",
            "instanceType":"t2.micro",
            "name":"t2.micro",
            "description":"General Purpose - Current Generation",
            "costPerHour":0.0116,
            "costPerHourPreferredCurrency":0.0,
            "hwSpec":{
               "memorySize":1024,
               "numOfCPUs":1,
               "cpuUnit":null,
               "numOfNICs":2,
               "localStorageCount":0,
               "localStorageSize":0,
               "cudaSupport":false,
               "ssdSupport":false,
               "supportHardwareProvision":false,
               "supportsPremiumStorage":false,
               "other":{

               }
            },
            "swSpec":{
               "support32bit":true,
               "support64bit":true,
               "support32On64":false,
               "osName":null
            },
            "displayCategory":null,
            "dummy":false,
            "deleted":false
         },
         "cloudType":"aws-us-east-1",
         "cloudName":"aws US East (Virginia)",
         "cloudFamily":"Amazon",
         "executorBean":"ChildTierAppExecutor",
         "depEnvName":"aws",
         "depEnvId":"3",
         "approvalRequestStatus":"",
         "approvalCategory":"",
         "approvalRequestAction":"",
         "agingPolicyName":null,
         "scalingPolicyName":null,
         "nodeStatusDefinitioname":null,
         "agingPolicy":null,
         "suspensionPolicy":null,
         "totalCost":0.6626532,
         "type":"leaf",
         "sourceAppId":96,
         "serviceId":7,
         "serviceType":"VM_AGENT",
         "rootAppId":93,
         "approvalRequestJaxb":{
            "id":null,
            "resource":null,
            "devEnvName":null,
            "fromDevEnvName":null,
            "initiatingUser":"Cliqr (admin@cliqrtech.com)",
            "lastApprovalInitiatingUser":null,
            "approvingUser":"Cliqr (admin@cliqrtech.com)",
            "lastApprovalAction":"Deployment",
            "requestTime":"1533711620836",
            "approvalTime":"1533711620836",
            "approvalStatus":"AUTO_APPROVED",
            "message":"Auto-Approved"
         },
         "sshAllowed":true,
         "vmActionAllowed":true,
         "chargeType":"Hourly",
         "childJobDetails":[

         ],
         "dependentStepNames":null,
         "securityProfileNames":[

         ],
         "nodeParams":{
            "x":"40",
            "y":"330"
         },
         "cloudSettings":{
            "cloud":"aws-us-east-1",
            "subnetId":"subnet-1fafee46",
            "CloudFamily":"Amazon",
            "accountDisplayName":"awsaccount",
            "nicInfo":"[{\"privateIPAllocationMode\":\"DHCP\",\"nicNetworkType\":\"NETWORK\",\"networkID\":\"subnet-1fafee46\",\"order\":1,\"publicIpAllocate\":true}]",
            "vpcId":"vpc-3e41595b",
            "numNICs":"1"
         },
         "storageJobName":null,
         "storageIp":null,
         "projectName":null,
         "phaseName":null,
         "phaseId":null,
         "projectId":null,
         "parentJobId":402,
         "parentJobName":"aaa",
         "logoPath":null,
         "jobMinimumNodeCount":1,
         "numNodes":2,
         "networkServices":null,
         "namespace":null,
         "labels":null,
         "referredJob":null,
         "referredJobName":null,
         "referredJobAccess":null,
         "preventTermination":false
      }
   ],
   "dependentStepNames":null,
   "securityProfileNames":[

   ],
   "nodeParams":null,
   "cloudSettings":{
      "cloud":"aws-us-east-1",
      "CloudFamily":"Amazon",
      "accountDisplayName":"awsaccount",
      "numNICs":"1"
   },
   "storageJobName":null,
   "storageIp":null,
   "projectName":null,
   "phaseName":null,
   "phaseId":null,
   "projectId":null,
   "parentJobId":null,
   "parentJobName":null,
   "logoPath":"/custom/assets/img/appLogo/fe9eb315-b699-46ff-ac25-81955bdaf4d9.png",
   "jobMinimumNodeCount":1,
   "numNodes":1,
   "networkServices":null,
   "namespace":null,
   "labels":null,
   "referredJob":null,
   "referredJobName":null,
   "referredJobAccess":null,
   "preventTermination":false
}

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String

Response Attributes

statusSummary
  • Description: Identifies the corresponding job status details for this job.

  • Type: Sequence of status details

    userId
    • Description: Unique, system-generated identifier for a user
    • Type: String

    jobId
    • DescriptionUnique, system-generated identifier for the job
    • Type: String

    jobStatusSummaryId
    • Description: Identifies the user associated with this job.

    • Type: Sequence of user and job details

      userId
      • Description: Unique, system-generated identifier for a user
      • Type: String

      jobId
      • DescriptionUnique, system-generated identifier for the job
      • Type: String

    jobName
    • Description: The name of this job
    • Type: String

    jobDesc
    • Description: A brief description for this CloudCenter Resource.

    • Type: String

    templateName
    • Description: Name of an application template
    • Type: String

    templateId
    • DescriptionUnique, system-generated identifier for an application template
    • Type: String

    instanceType
    • Description: The instance type for this external service. See Manage Instance Types for additional context.
    • Type: String

    status
    • Description: Status of the job/deployment. See the Application Deployment, VM, and Container States section for the relevant release for additional context.
    • Type: Enumeration

      EnumerationDescription
      allAll jobs or deployments in this CloudCenter instance.
      runningRunning (successful) jobs or deployments in this CloudCenter instance.
      activeActive (any live state, in addition to the running state) jobs or deployments in this CloudCenter instance.

    deploymentStatus
    • Description: The deployment status for this project. 
    • Type: Enumeration. See the Application Deployment, VM, and Container States section for the relevant release for additional context.

    startTime

    endTime

    scheduleEndTime


    timeZone
    • Description: Identifies the timezone for your location

    • Type: String

    lastUpdateTime

    version
    • Description: The application build version.

    • Type: String

    tag
    • DescriptionThe tag associated with this resource. Each string represents a system tag. See the System Tags section for the relevant release for additional context.

    • Type: String

    msg
    • Description: The job details log message.
    • Type: String

    eventTime

status (nodeStatus)
  • Description: The node status for this resource. 

  • Type: Enumeration. See the Deployment and VM States > VM (Node) States section for the relevant release for additional details.

nodeStateSummary
  • Description: Identifies the number of times that the node was in each state as described in the Deployment and VM States > VM (Node) States section.
  • Type: Array of node states

    NodeResumed
    NodeNotFound
    NodeReachable
    NodeNotReachable
    NodeBootingFailed
    NodeSuspending
    NodeStarting
    NodeBooting
    NodeError
    NodeReady
    NodeCleaned
    NodeResuming
    NodeStarted
    NodeLaunching
    NodeTerminating
    NodeTerminated
    NodeSuspended

envVars
  • Description: Information about the environment variables used in this CloudCenter resource.
  • Type: Array of name-value pairs

    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

appParams
  • Description: Information about the application property
  • Type: Array of name-value pairs

    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

publicIpAddress
  • Description: Public IP address of the application VM or CCO. This attribute is the same as the publicIp or publicIpAddr attributes.
  • Type: String

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

  • Type: String

resource
  • Description: Unique URL to access this resource.
  • Type: String
perms (click for additional details)
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
type
  • DescriptionThe type of resource
  • Type: String
regionId
  • DescriptionUnique, system-generated identifier for the cloud region 

  • Type: String

costPerHour
  • Description:  The dollar price per hour to use this service. Only the user who created this service (service owner) can set this value (once) for all users using this service.
  • Type: Float
memorySize
  • DescriptionThe RAM size in MB for this Instance Type. See the Map Images section for the relevant release for additional context.
  • Type: Integer
numOfCpus
  • DescriptionThe number of CPUs for this instance type or cloud Image. This attribute is the same as the minNumberOfCpus attribute.
  • Type: Integer
numOfNics
  • Description: The number of Network Interface Cards (NICs) attached to this instance type or cloud image.

  • Type: Integer
localStorageSize
  • Description: The local storage size in GB
  • Type: Integer
supportsCuda (deprecated)
  • Description: Indicates whether CUDA is supported for this instance type. This attribute is the same as the cudaSupport attribute

  • Type: Boolean
    • true = CUDA is supported for this instance type
    • false = CUDA is not supported for this instance type
supportsSsd
  • Description: Indicates whether SSD is supported for this instance type. This attribute is the same as the ssdSupport attribute.

  • Type: Boolean

    • true = SSD is supported for this instance type
    • false = SSD is not supported for this instance type
supports32Bit
  • Description: Indicates whether 32-bit architecture is supported for this instance type

    • true = 32-bit architecture is supported for this instance type
    • false = 32-bit architecture is not supported for this instance type
  • Type: Boolean
supports64Bit
  • Description: Indicates whether 64-bit architecture is supported for this instance type

    • true = 64-bit architecture is supported for this instance type
    • false = 64-bit architecture is not supported for this instance type
  • Type: Boolean
localStorageCount
  • Description: Enables a user to specify the number of additional instance stores (instance storage) that can attached to the Application VM. AWS use this concept of Instance Storage and CloudCenter enables users to create these additional stores using this attribute:
    • Default = 0
    • Minimum = 1
    • Maximum = 24
  • Type: Integer
supportsHardwareProvision 
  • Description: Identifies if hardware provisioning is supported. See the Provisioning Bare Metal Hardware Servers section for the relevant release for additional context:
    • true = Supports hardware provisioning
    • false = Does not support hardware provisioning
  • Type: Boolean

cloudType
  • Description: The type of associated cloud
  • Type: String

cloudName
  • Description: The cloud family name as referenced in the Public Clouds section or the Datacenters and Private Clouds section or the Container Clouds section for the relevant release for a complete list.
  • Type: String

cloudFamily                                                                                                                                                                                
  • Description: The cloud provider name.                     
  • Type: String

depEnvName
  • Description: The name of the deployment environment. See the Deployment Environments section for the relevant release for additional details.
  • Type: String

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

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


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


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

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
perms (click for additional information)
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
 entityType 
  • Description: Identifies the resource type for this action.
  • Type: Sequence of type and display name

    typeName
    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
eventName
  • Description: Identifies the event that, when it affects the configured resource, causes a policy to execute. 

  • Type: Enumeration

    API Event Name

    UI Display - Description

    Supported Policy actionType(s)
     submitted 

    Submitted – The configured application is submitted for deployment.

    • EMAIL 
    • INVOKE_WEB_SERVICE 
    status_change

    Status Changed   Status of the specified deployment for the configured application has changed.

    • EMAIL 
    • INVOKE_WEB_SERVICE
    • OS_COMMAND 
     Deployed 

     Deployed  –  The specified deployment for the configured application was successfully deployed.

    • EMAIL
    •  INVOKE_WEB_SERVICE
    • OS_COMMAND 
     rerun Rerun  –  The specified deployment for the configured application is submitted for a rerun 
    • EMAIL
    •  INVOKE_WEB_SERVICE
    scale_upScale Out  –  The specified deployment for the configured application was scaled out based on your scaling policy.
    • EMAIL
    •  INVOKE_WEB_SERVICE
    • OS_COMMAND 
    scale_down

    Scale In  –  The specified deployment for the configured application was scaled in based on your scaling policy.

    • EMAIL
    •  INVOKE_WEB_SERVICE
    • OS_COMMAND 
    ScheduledScalingScheduled Scaling  –  The specified deployment for the configured application was scaled based on your scheduled scaling policy.
    • EMAIL
    •  INVOKE_WEB_SERVICE
    • OS_COMMAND

    max_cluster_size_reached

    Maximum cluster size limit reached  – The specified deployment for the configured application has reached the configured maximum cluster size limit.

    • EMAIL 
    •  INVOKE_WEB_SERVICE 
    • OS_COMMAND 
    • LAUNCH_NEW_DEPLOYMENT 
    min_cluster_size_reached Minimum cluster size limit reached – The specified deployment for the configured application has reached the configured minimum cluster size limit.
    • EMAIL
    •  INVOKE_WEB_SERVICE
    • OS_COMMAND 
     cancelled  Cancelled  – The specified deployment for the configured application has been cacelled by the owner.
    • EMAIL
    •  INVOKE_WEB_SERVICE

 

actions
  • Description: Identifies details for the configured action policy See the Policy Management section for the relevant release for additional context.

  • Type: Array of action types

    actionType
    • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
    • Type: Enumeration

      EnumerationDescription
      SCRIPT

      Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

      The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
      - Linux VMs = /usr/local/osmosix/service/serviceName
      - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

      See the Service Lifecycle Action section for the relevant release for additional context.

       This option is not available for Container Service.

      URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

      The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
      CMD

      Indicates the command that is be executed on the VM during actionName step.

      The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

      - Linux VMs = cliqruser

      - WindowsVMs = cliqr

      See the Service Lifecycle Action section for the relevant release for additional context.

      Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

     
    actionInputs
    • Description: Identifies the parameter for an configured activity. See Policy Management > Action Policy for additional context.
    • Type: Name-Value Pair
     associatedParams 
    • Description: The parameters associated with the selected action typeName
    • Type: Name-Value Pair
userId
  • Description: Unique, system-generated identifier for a user
  • Type: String
enabled
  • Description: Indicates that this resource has been enabled. The default differs based on the resource.

    • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

    • false = The resource has not been enabled.

  • Type: Boolean

autoEnable
  • Description: Identifies if this policy must be automatically enabled for all shared users and sub-tenants:
    • true = this policy is automatically enable 
    • false = this policy is not enabled  
  • Type: Enumeration
forceEnable
  • Description: If this flag is true, the policy is enforced for all shared users and sub-tenants. This attribute can be set to true only if autoEnable is also set to true. 
    • true = this policy is enforced
    • false = this policy is not enforced   
  • Type: Enumeration
global
  • Description: Identifies if this is a global policy. Some policies like a Job Status Change - Email Policy are global policies and are available by default to all users. If a policy created by a user, it is not global policy. This system-defined attribute cannot be configured.

    • true = this is a global policy
    • false = this is not a global policy
  • Type: Boolean

suspensionPolicyId
  • Description: Unique, system-generated identifier for the suspension policy.
  • Type: String

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

type
  • DescriptionThe type of resource
  • Type: String

serviceId
  • DescriptionUnique, system-generated identifier for a service. This ID only uses and accepts alphanumeric characters.
  • Type: String

serviceType
  • Description: The types of service buckets provided by the CloudCenter to define a new service. See External Service and Cloud Service for additional context.

  • Type: Enumeration

    EnumerationDescription
    VM_AGENTDefault. Service based on a VM with a Management Agent
     VM_NO_AGENTService based on a VM without a Management Agent
     EXTERNAL External Service
    CONTAINERContainer Service (effective CloudCenter 4.9.0)

approvalRequest
  • Description: Identifies the process of approval for the job/deployment environment.
  • Type: Sequence of attributes for the request

    currentDeploymentEnvironment 
    • Description: Identifies the process of approval for the current deployment environment.

    • Type: Sequence 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
    fromDeploymentEnvironment
    • Description: Identifies the process of approval for the originating deployment environment. Applies to the PROMOTE status

    • Type: Sequence 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
    initiatingUser
    • Description: Identifies the user who has started the request for approval.

    • Type: Sequence 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
    approvingUser
    • Description: Identifies the user who approves the job based on deployment environment permissions.

    • Type: Sequence 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

    requestTime
    • Description: Unix time in milliseconds (see CloudCenter API Overview > Date Format) to identify the exact time that this approval was requested.
    • Type: Long

    approvalTime
    • Description: Unix time in milliseconds (see CloudCenter API Overview > Date Format) to identify the exact time that this approval was approved.
    • Type: Long
    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

     

    message
    • Description: Identifies the the resulting message for the approval request.

    • Type: String

      EnumerationDescription
      PENDINGThe job request is pending approval.
      APPROVEDThe job request has been approved.
      REJECTEDThe job request was rejected.
      AUTO_APPROVEDApproved by default. For example, the admin submits a job and does not require approval. Similarly, approvingUser, requestTime, approvalTime  also do not require approval – if there an approval chain is in place.

action
  • Description: Identifies the valid operations that can be performed on the VM.
  • Type: Array of Enumeration vmAction

    Enumeration Description
    STARTStart this VM
    STOPStop this VM
    REBOOTReboot this VM
    DELETEDelete this VM

childJobs
  • Description: Identifies applicable information for each child job
  • Type: Sequence of attributes for the child job

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

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    attributes
    • Description: Information about the cloud property
    • Type: Array of name-value pairs

      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

securityProfileIds
  • Description: Identifies a list of security profile identifiers to be associated with a job. This attribute is only valid in non-governance mode.
  • Type: Long

projectName
  • DescriptionThe name assigned for a project (see Projects and Phases for additional context). Valid characters are letters, numbers, underscores, and spaces.
  • Type: String

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

deploymentEnvironment (click for additional details)
order
  • Description: The number at which a resource is to be attached. When updating a phase, use this order to re-order the resource to a different position in the array of resources.
  • Type: Long
phasePlan
  • Description: Identifies the plan associated with this phase
  • Type: Sequence of objects

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

    • Type: String

    planName
    • DescriptionA descriptive name for this plan
    • Type: String
phaseBundles
  • Description: List of bundles attached to the phase. This is only valid for phase(s) with Budget pre-paid Bundle plan. For other plans, an empty JSON object is displayed.
  • Type: Array of bundles

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

    • Type: String

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

    • Type: String

    count
    • Description: The number of times that this phase bundle was added/attached.

      On successful image creation, this value will always remain 0.

    • TypeInteger

phaseCost
  • Description: The cost of this phase
  • Type: Sequence of objects

    originalBalance
    • Description: The opening account balance for this user, project, or phase
    • Type: Float
    remainingBalance
    • Description: Available balance in this user's plan, project, or phase
    • Type: Float
    measurableUnit
    • Type: String

deployments
  • Description: List of deployments attached to the phase 


  • Type: Array of deployments

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

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)
    deploymentName
    • Description: The project name
    • Type: String
     deploymentOwnerId
    • Description: Unique, system-generated identifier for the user who owns this project.
    • Type: String
    deploymentStatus
    • Description: The deployment status for this project. 
    • Type: Enumeration. See the Application Deployment, VM, and Container States section for the relevant release for additional context.

    appName
    • Description: The name of the application in use.
    • Type: String
    appVersion
    • Description: The application build version with which a new job is started. If the appVersion is not specified, the latest application build version is used.

    • Type: String
    appLogoPath
    • Description: The relative path of the uploaded image logo file for this application.   
    • Type: String
    supportedActions
    • Description: Identifies the supported actions for each deployment. Users can perform several functions based on their deployment permissions.

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

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

    • Type: Enumeration

      Enumeration Description
      APPROVEApprove a deployment request.
      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.

projectId
  • DescriptionUnique, system-generated identifier for the project
  • Type: Long (path variable in the URL)

parentJobId
  • DescriptionUnique, system-generated identifier for the parent job
  • 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

logoPath
  • Type: String

numNodes
  • DescriptionThe number of nodes in this storage configuration
  • Type: Integer

preventTermination
  • Description: When set for a deployment/job, this attribute ensures that the deployment/job cannot be suspended, stopped, removed, or deleted. See Prevent Termination for additional context.
  • Type: Boolean
    • true = Termination is disabled.
    • false = Termination is enabled.

  • No labels
Terms & Conditions Privacy Statement Cookies Trademarks