List Jobs

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameList Jobs
Description

Retrieve a list of all jobs submitted by a user

Allowed Role(s)WM_USER
MethodGET
URI
  • v1/jobs
  • v1/ jobs?appDetails=true&status=running

  • cloudcenter-ccm-backend/api/v1/jobs
  • cloudcenter-ccm-backend/api/v1/ jobs?appDetails=true&status=running

Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs"
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/jobs"
Release
  • CloudCenter 3.x and 4.x
  • Enhanced in CloudCenter 4.2 to:
    • List both jobs and deployments as jobs
    • Include the provisionBareMetal, displayName, appLogoPath, depInitiatingUserId, environmentId, environmentApprovalStatus, cost, isOwner, deploymentInfo, type, deploymentStatus and terminateProtection attributes
  • Enhanced in CloudCenter 4.5 to include optional query parameters identified in the Request Attributes section below
  • Enhanced in CloudCenter 4.8.2 to include the approvalRequestAction and approvalRequestStatus attributes
  • Enhanced in CloudCenter 4.9.1 to include the following elements (see Example 3 below):
      • estimatedSavingsPercentage
      • estimatedHourlyCost
      • estimatedMonthlyCost
      • estimatedMonthlySavings
      • addSuspensionPolicy
      • currencyCode
      • policySavings

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • The list jobs API does not list Projects and Phase-based deployments.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: get.jobs

actionparam: appDetails=true&status=running

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

Not applicable

Sample Response 1

{
    "jobs": [
        {
            "id": "1768",
            "resource": "https://<HOST>:<PORT>/v1/jobs/1768",
            "perms": [
                "authorize",
                "execute",
                "approve",
                "write",
                "delete",
                "read",
                "move_out",
                "manage",
                "move_in",
                "administration"
            ],
            "name": "jenkins-vet-sep8-2_run_1",
            "displayName": "jenkins-vet-sep8-2",
            "status": "Running",
            "deploymentStatus":"Deployed",
            "appId": "566",
            "appVersion": "2",
            "appName": "JenkinSingleNIC",
            "appLogoPath": null,
            "cloud": "OpenStack-Vet-Cloud-Region",
            "instance": null,
            "depInitiatingUserId": "2",
            "environmentId": "3",
            "environment": "Vet-Deploy-Env1",
            "environmentApprovalStatus": Auto-Approved,
            "startTime": "2015-09-08 08:03:28.0",
            "endTime": "N/A",
            "cost": {
                "nodeHours": 0,
                "billedNodeHours": 0,
                "cloudCost": 0,
                "appCost": 0,
                "totalCost": 0
            },
            "isOwner": false,
            "deploymentInfo": {
                "deploymentId": 453,
                "deploymentName": "jenkins-vet-sep8-2",
                "deploymentHealthStatus": "Healthy",
                "deploymentStatus": "Deployed",
                "isSuspendSupported": true,
                "isDeploymentTerminated": false
            },
            "type": "DEPLOYMENT",
            "terminateProtection": false
            "provisionBareMetal": false
        },
        {
            "name": "vet-sleek-aug21",
            "displayName": "vet-sleek-aug21",
            "status": "Finished",
            "appId": "558",
            "appVersion": "1",
            "appName": "batchapp",
            "appLogoPath": null,
            "cloud": "OpenStack-Vet-Cloud-Region",
            "instance": null,
            "depInitiatingUserId": "2",
            "environmentId": "1",
            "environment": "Vet-Deploy-Env",
            "environmentApprovalStatus": null,
            "startTime": "2015-08-21 16:19:05.0",
            "endTime": "2015-08-21 21:56:22.0",
            "cost": {
                "nodeHours": 5.62001,
                "billedNodeHours": 5.62001,
                "cloudCost": 6,
                "appCost": 0,
                "totalCost": 6
            },
            "isOwner": false,
            "deploymentInfo": null,
            "type": "JOB",
            "terminateProtection": false
            "provisionBareMetal": false
        }
    ]
}

Example 2

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs?appDetails=true&status=running"

Response

{
    "resource": "https://<HOST>:<PORT>/v1/jobs?appDetails=true&status=running",
    "size": 6,
    "pageNumber": 0,
    "totalElements": 6,
    "totalPages": 1,
    "jobs": [{
        "id": "5519",
        "resource": "https://<HOST>:<PORT>/v1/jobs/5519",
        "perms": ["read", "write", "manage", "administration", "approve", "delete", "move_in", "move_out", "execute"],
        "name": "NFS_F1_run_1",
        "displayName": "NFS_F1",
        "status": "Running",
        "appId": "775",
        "appVersion": "Centos6.x",
        "appType": "NTIER",
        "appName": "NFS",
        "appLogoPath": "/assets/img/appLogo/775/logo.png",
        "cloud": "Amazon-us-west-2",
        "instance": null,
        "multiCloudSupport": false,
        "depInitiatingUserId": "5",
        "environmentId": "2",
        "environment": "Default",
        "environmentApprovalStatus": null,
        "startTime": "2016-04-06 16:08:10.0",
        "endTime": "N/A",
        "cost": {
            "nodeHours": 2040.3855,
            "billedNodeHours": 2040.3855,
            "cloudCost": 26.507114,
            "appCost": 0.0,
            "totalCost": 26.507114
        },
        "isOwner": true,
        "deploymentInfo": {
            "deploymentId": 1539,
            "deploymentName": "NFS_F1",
            "deploymentHealthStatus": "Down",
            "deploymentStatus": "Deployed",
            "isSuspendSupported": true,
            "isDeploymentTerminated": false
        },
        "type": "DEPLOYMENT",
        "actions": ["SUSPEND", "TERMINATE", "TERMINATE_AND_HIDE", "UPGRADE", "PROMOTE", "MIGRATE", "ON_TERMINATE_PROTECTION"],
        "terminateProtection": false,
        "hidden": false,
        "userFavorite": false
    }, {
        "id": "7895",
        "resource": "https://<HOST>:<PORT>/v1/jobs/7895",
        "perms": ["read", "authorize", "write", "manage", "administration", "approve", "delete", "move_in", "move_out", "execute"],
        "name": "WP_ZF_10_run_1",
        "displayName": "WP_ZF_10",
        "status": "Running",
        "appId": "30",
        "appVersion": "3.7",
        "appType": "NTIER",
        "appName": "WordPress_App",
        "appLogoPath": "/assets/img/appLogo/30/logo.png",
        "cloud": "Amazon-us-east-1",
        "instance": null,
        "multiCloudSupport": false,
        "depInitiatingUserId": "5",
        "environmentId": "211",
        "environment": "zfeng",
        "environmentApprovalStatus": null,
        "startTime": "2016-06-30 02:22:34.0",
        "endTime": "N/A",
        "cost": {
            "nodeHours": 86.83472,
            "billedNodeHours": 86.83472,
            "cloudCost": 9.450001,
            "appCost": 0.0,
            "totalCost": 9.450001
        },
        "isOwner": true,
        "deploymentInfo": {
            "deploymentId": 2385,
            "deploymentName": "WP_ZF_10",
            "deploymentHealthStatus": "UnHealthy",
            "deploymentStatus": "Deployed",
            "isSuspendSupported": true,
            "isDeploymentTerminated": false
        },
        "type": "DEPLOYMENT",
        "actions": ["SUSPEND", "TERMINATE", "TERMINATE_AND_HIDE", "UPGRADE", "PROMOTE", "MIGRATE", "ON_TERMINATE_PROTECTION"],
        "terminateProtection": false,
        "hidden": false,
        "userFavorite": false
    }, {
        "id": "7903",
        "resource": "https://<HOST>:<PORT>/v1/jobs/7903",
        "perms": ["read", "authorize", "write", "manage", "administration", "approve", "delete", "move_in", "move_out", "execute"],
        "name": "wp_zf_12_run_1",
        "displayName": "wp_zf_12",
        "status": "Running",
        "appId": "30",
        "appVersion": "3.7",
        "appType": "NTIER",
        "appName": "WordPress_App",
        "appLogoPath": "/assets/img/appLogo/30/logo.png",
        "cloud": "Amazon-us-east-1",
        "instance": null,
        "multiCloudSupport": false,
        "depInitiatingUserId": "5",
        "environmentId": "211",
        "environment": "zfeng",
        "environmentApprovalStatus": null,
        "startTime": "2016-06-30 02:53:45.0",
        "endTime": "N/A",
        "cost": {
            "nodeHours": 56.39111,
            "billedNodeHours": 56.39111,
            "cloudCost": 6.1950006,
            "appCost": 0.0,
            "totalCost": 6.1950006
        },
        "isOwner": true,
        "deploymentInfo": {
            "deploymentId": 2387,
            "deploymentName": "wp_zf_12",
            "deploymentHealthStatus": "UnHealthy",
            "deploymentStatus": "Deployed",
            "isSuspendSupported": true,
            "isDeploymentTerminated": false
        },
        "type": "DEPLOYMENT",
        "actions": ["SUSPEND", "TERMINATE", "TERMINATE_AND_HIDE", "UPGRADE", "PROMOTE", "MIGRATE", "ON_TERMINATE_PROTECTION"],
        "terminateProtection": false,
        "hidden": false,
        "userFavorite": false
    }, {
        "id": "573",
        "resource": "https://<HOST>:<PORT>/v1/jobs/573",
        "perms": ["read", "write", "manage", "administration", "approve", "delete", "move_in", "move_out", "execute"],
        "name": "NFS_run_1",
        "displayName": "NFS",
        "status": "Running",
        "appId": "775",
        "appVersion": "Centos6.x",
        "appType": "NTIER",
        "appName": "NFS",
        "appLogoPath": "/assets/img/appLogo/775/logo.png",
        "cloud": "Amazon-us-west-2",
        "instance": null,
        "multiCloudSupport": false,
        "depInitiatingUserId": "5",
        "environmentId": "2",
        "environment": "Default",
        "environmentApprovalStatus": null,
        "startTime": "2016-03-16 11:15:58.0",
        "endTime": "N/A",
        "cost": {
            "nodeHours": 2549.1538,
            "billedNodeHours": 2549.1538,
            "cloudCost": 112.065834,
            "appCost": 0.0,
            "totalCost": 112.065834
        },
        "isOwner": true,
        "deploymentInfo": {
            "deploymentId": 149,
            "deploymentName": "NFS",
            "deploymentHealthStatus": "Down",
            "deploymentStatus": "Deployed",
            "isSuspendSupported": true,
            "isDeploymentTerminated": false
        },
        "type": "DEPLOYMENT",
        "actions": ["UPGRADE", "PROMOTE", "OFF_TERMINATE_PROTECTION"],
        "terminateProtection": true,
        "hidden": false,
        "userFavorite": false
    }, {
        "id": "2893",
        "resource": "https://<HOST>:<PORT>/v1/jobs/2893",
        "perms": ["read", "write", "manage", "administration", "approve", "delete", "move_in", "move_out", "execute"],
        "name": "jt7_run_1",
        "displayName": "jt7",
        "status": "Running",
        "appId": "1431",
        "appVersion": "1",
        "appType": "NTIER",
        "appName": "jenkins",
        "appLogoPath": "/assets/img/appLogo/1431/logo.png",
        "cloud": "OpenStack-US",
        "instance": null,
        "multiCloudSupport": false,
        "depInitiatingUserId": "5",
        "environmentId": "6",
        "environment": "Openstack",
        "environmentApprovalStatus": null,
        "startTime": "2016-03-29 22:22:06.0",
        "endTime": "N/A",
        "cost": {
            "nodeHours": 2226.127,
            "billedNodeHours": 2226.127,
            "cloudCost": 22.240414,
            "appCost": 0.0,
            "totalCost": 22.240414
        },
        "isOwner": true,
        "deploymentInfo": {
            "deploymentId": 777,
            "deploymentName": "jt7",
            "deploymentHealthStatus": "Down",
            "deploymentStatus": "Deployed",
            "isSuspendSupported": true,
            "isDeploymentTerminated": false
        },
        "type": "DEPLOYMENT",
        "actions": ["SUSPEND", "TERMINATE", "TERMINATE_AND_HIDE", "UPGRADE", "PROMOTE", "MIGRATE", "ON_TERMINATE_PROTECTION"],
        "terminateProtection": false,
        "hidden": false,
        "userFavorite": false
    }, {
        "id": "3095",
        "resource": "https://<HOST>:<PORT>/v1/jobs/3095",
        "perms": ["read", "write", "manage", "administration", "approve", "delete", "move_in", "move_out", "execute"],
        "name": "ArtifactoryServer-GOOGLE_run_1",
        "displayName": "ArtifactoryServer-GOOGLE",
        "status": "Running",
        "appId": "771",
        "appVersion": "1.0",
        "appType": "NTIER",
        "appName": "ArtifactoryServer",
        "appLogoPath": "/assets/img/appLogo/771/logo.png",
        "cloud": "Google-us-central1",
        "instance": null,
        "multiCloudSupport": false,
        "depInitiatingUserId": "10",
        "environmentId": "10",
        "environment": "Google",
        "environmentApprovalStatus": null,
        "startTime": "2016-03-30 11:32:52.0",
        "endTime": "N/A",
        "cost": {
            "nodeHours": 2212.9246,
            "billedNodeHours": 2212.9246,
            "cloudCost": 154.7723,
            "appCost": 0.0,
            "totalCost": 154.7723
        },
        "isOwner": false,
        "deploymentInfo": {
            "deploymentId": 845,
            "deploymentName": "ArtifactoryServer-GOOGLE",
            "deploymentHealthStatus": "Down",
            "deploymentStatus": "Deployed",
            "isSuspendSupported": true,
            "isDeploymentTerminated": false
        },
        "type": "DEPLOYMENT",
        "actions": ["UPGRADE", "PROMOTE", "OFF_TERMINATE_PROTECTION"],
        "terminateProtection": true,
        "hidden": false,
        "userFavorite": false
    }]
}


Example 3 – Suspension Policies


curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs?appDetails=true&includeBenchmark=false&page=0&size=50&sort=id-&order=asc"


Response


{
	"resource": "https://<HOST>:<PORT>/v1/jobs?appDetails=true&includeBenchmark=false&page=0&size=50&sort=id-&order=asc",
	"size": 2,
	"pageNumber": 0,
	"totalElements": 2,
	"totalPages": 1,
	"jobs": [{
		"id": "43",
		"resource": "https://<HOST>:<PORT>/v1/jobs/43",
		"perms": ["authorize", "read", "approve", "execute", "write", "administration", "move_out", "move_in", "delete", "manage"],
		"name": "DEP1",
		"displayName": "DEP1",
		"status": "Running",
		"approvalRequestStatus": null,
		"approvalRequestAction": null,
		"jobStatusMessage": null,
		"nodeId": null,
		"appId": "31",
		"appVersion": "0.1",
		"appType": "NTIER",
		"appName": "TEST",
		"appLogoPath": "/custom/assets/img/appLogo/434f14fe-b0f8-4a80-92aa-08825c312b44.png",
		"cloud": "AWS-us-east-1",
		"cloudFamily": "Amazon",
		"cloudDisplayName": "AWS US East (Virginia)",
		"instance": null,
		"multiCloudSupport": false,
		"depInitiatingUserId": "2",
		"userCloudAccountId": "2",
		"environmentId": "1",
		"environment": "TestEnvironment",
		"environmentApprovalStatus": null,
		"startTime": "2018-05-07 05:01:58.576",
		"endTime": "N/A",
		"scheduleEndTime": "N/A",
		"startTimeEpoch": 1525669318576,
		"endTimeEpoch": 0,
		"scheduleEndTimeEpoch": 0,
		"timeZone": "GMT+05:30",
		"favoriteCreationTime": "N/A",
		"cost": {
			"nodeHours": 3.9572222,
			"billedNodeHours": 3.9572222,
			"cloudCost": 0.0464,
			"appCost": 0.0,
			"totalCost": 0.0464
		},
		"isOwner": true,
		"deploymentInfo": {
			"deploymentId": 9,
			"deploymentName": "DEP1",
			"deploymentHealthStatus": "Healthy",
			"deploymentStatus": "Deployed",
			"deploymentOwnerId": 0,
			"isSuspendSupported": true,
			"containsExternalServices": false,
			"isDeploymentTerminated": false
		},
		"type": "DEPLOYMENT",
		"actions": ["SUSPEND", "TERMINATE", "TERMINATE_AND_HIDE", "UPGRADE", "PROMOTE", "MIGRATE", "EXPORT_TO_REPO", "SHARE"],
		"terminateProtection": false,
		"hidden": false,
		"userFavorite": false,
		"benchmarkJob": false,
		"customActions": [],
		"estimatedMonthlyCost": 1.3421664,
		"estimatedHourlyCost": 0.00186412,
		"estimatedMonthlySavings": 7.009834,
		"policySavings": [{
			"type": "SUSPENSION_POLICY",
			"name": "pl_3",
			"estimatedSavingsPercentage": 83.93
		}],
		"currencyCode": "USD",
		"addSuspensionPolicy": true
	}, {
		"id": "42",
		"resource": "https://<HOST>:<PORT>/v1/jobs/42",
		"perms": ["authorize", "read", "approve", "execute", "write", "administration", "move_out", "move_in", "delete", "manage"],
		"name": "test-5",
		"displayName": "test-5",
		"status": "Error",
		"approvalRequestStatus": null,
		"approvalRequestAction": null,
		"jobStatusMessage": "Failed to start job: null",
		"nodeId": null,
		"appId": "33",
		"appVersion": "1",
		"appType": "LEGACY",
		"appName": "test-Batch",
		"appLogoPath": "/custom/assets/img/appLogo/29ae133e.png",
		"cloud": "AWS-us-east-1",
		"cloudFamily": "Amazon",
		"cloudDisplayName": "AWS US East (Virginia)",
		"instance": null,
		"multiCloudSupport": false,
		"depInitiatingUserId": "2",
		"userCloudAccountId": "2",
		"environmentId": "1",
		"environment": "TestEnvironment",
		"environmentApprovalStatus": null,
		"startTime": "2018-05-04 10:30:21.82",
		"endTime": "2018-05-04 10:30:24.644",
		"scheduleEndTime": "N/A",
		"startTimeEpoch": 1525429821820,
		"endTimeEpoch": 1525429824644,
		"scheduleEndTimeEpoch": 0,
		"timeZone": "UTC",
		"favoriteCreationTime": "N/A",
		"cost": {
			"nodeHours": 0.0,
			"billedNodeHours": 0.0,
			"cloudCost": 0.0,
			"appCost": 0.0,
			"totalCost": 0.0
		},
		"isOwner": true,
		"deploymentInfo": null,
		"type": "JOB",
		"actions": ["RERUN", "STOP", "HIDE"],
		"terminateProtection": false,
		"hidden": false,
		"userFavorite": false,
		"benchmarkJob": false,
		"customActions": [],
		"estimatedMonthlyCost": 31.68,
		"estimatedHourlyCost": 0.044,
		"estimatedMonthlySavings": 0.0,
		"policySavings": [],
		"currencyCode": "USD",
		"addSuspensionPolicy": false
	}]
}


Request Attributes

appDetails
  • Description: Displays the latest application details for each application.
  • Type: Boolean
    • true = provides the application details
    • false = does not provide the application details

Optional query attribute – used in Example 2 and included in the Response Attributes list below

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.

Optional query attribute – used in Example 2 and included in the Response Attributes list below

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

  • Type: String

Optional query attribute

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

Optional query attribute

phaseId
  • DescriptionUnique, system-generated identifier for the phase.
  • Type: String

Optional query attribute

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

Optional query attribute

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

    • true = Displays jobs marked as favorite
    • false = (default) Displays marked and unmarked jobs

Optional query attribute

includeHidden
  • Description: Identifies if a job/deployment is hidden by a user. See Termination > Terminate Existing Deployment  for additional context
  • Type: Boolean

    • true = Displays hidden jobs
    • false = (default) Excludes hidden jobs

Optional query attribute

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

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


  • Type: Boolean

    • true = (default) Displays benchmarked jobs
    • false = Excludes benchmarked jobs

Optional query attribute


Response Attributes

jobs
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

displayName
  • DescriptionA descriptive name for this CloudCenter resource.
  • 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.

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

  • Type: Enumeration


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

  • Type: String


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

  • 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
appName
  • Description: The name of the application in use.
  • Type: String
appLogoPath
  • Description: The relative path of the uploaded image logo file for this application.   
  • Type: String
cloud
  • Description: Cloud where the job was launched
  • Type: String
instance
  • Description: The name of the cloud Instance type that is used to start the new job. See the Manage Instance Types section for the relevant release for additional context.
  • Type: String

depInitiatingUserId
  • Description: Unique, system-generated identifier for the user who initiated this deployment
  • Type: String

environmentId
  • Description: Unique, 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 depEnvId attribute.
  • Type: String

environment
  • Description: The name of the deployment environment.
  • Type: String

environmentApprovalStatus
  • Description: Identifies the approval status if approval is required to deploy to this environment. See the Deployment Environment section for the relevant release for additional context
  • Type: Enumeration

    EnumerationDescription
    Approved Deployment to this deployment environment was manually approved.
    Auto-ApprovedDeployment to this deployment environment was automatically approved.
    RejectedDeployment to this deployment environment was rejected.

    Pending

    Deployment to this deployment environment is pending approval.
    Not Applicable?? 

startTime
endTime
  • Description: Job end time
  • Type: String
cost(v1details) (click for additional details)

isOwner
  • Description: Indicates whether this user is the job/deployment owner. This attribute is the same as the owner attribute.
  • Type: Boolean
    • true = This user is the job/deployment owner
    • false = Default. This user is not the job/deployment owner

deploymentInfo (click for additional details)
type
  • Description: Identifies if the listed entity is a job or a deployment.
  • Type: Enumeration

    EnumerationDescription
    JOB
    • A job is a single action that contains many properties (for example, ownership, cloud cost, deployment information, and so forth).
    • A job can contain other child jobs or is the child of a parent job.
    DEPLOYMENT
    • An application deployment
    • A deployment contains a set of jobs (for example, creating a VM).
    • Deployments do not have the concept of child or parent, but merely bundles jobs together so it can share properties between the jobs (for example, sharing properties between VMs in an application deployment).
 terminateProtection 
  • Description: Identifies if terminate protection enabled for the deployment for this job. See the Terminate Protection section for the relevant release for additional context.
    • true = Terminate protection is enabled.
    • false = Default. Terminate protection is disabled.
  • Type: Boolean
 provisionBareMetal 
  • Description: Identifies if the machines should be provisioned as bare metal hardware. See the Provisioning Bare Metal Hardware Servers section for the relevant release for additional context.
  • Type: Boolean
    • true = Bare metal hardware is provisioned and enabled for all tiers in the application
    • false = (Default) Bare metal hardware is not provisioned
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.
userFavorite
  • 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 favorite attribute.
  • Type: Boolean
    • true = Marks this job as a favorite for the user.
    • false = Default. Does not mark the job as a favorite.
benchmarkJob
  • Description: Identifies if the benchmark status for inclusion. See the Benchmark Applications section for the relevant release and API Error Codes for additional context. This attribute is the same as the benchmark attribute.
  • Type: Boolean
    • true = Marks the benchmark status for inclusion.
    • false = Default. The benchmark status is not marked for inclusion.
estimatedHourlyCost
  • Description: Identifies the approximate cost for each hour based on the uptime schedule. Blockout dates are not used in this calculation as the time frame is indeterminate.

  • Type: Float

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

  • Type: Float

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

  • Type: Float

policySavings
  • Description: Identifies the expected percent cost savings.

  • Type: Array of savings details

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

    • Type: Float

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

    • Type: String

    type
    • DescriptionThe type of resource
    • Type: String

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

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


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

  • Type: Boolean

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

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




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