// removed jquery ui css and js

List Jobs

Details

API Details
Name

List Jobs

DescriptionRetrieve a list of all jobs submitted by a user
MethodGET
URI
  • /v1/jobs
  • /v1/ jobs?appDetails=true&status=running

CloudCenter 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.
Notes
  • API Overview Notes
    • For additional context on <PORT> usage in the following example(s), see Base URI Format.
    • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview > Pagination  section for additional context.
  • List Jobs Notes
    • The list jobs API does not list Projects and Phase-based deployments. It only lists deployments that are outside the scope of these CloudCenter resources.
ESB Header

action: get.jobs

actionparam: appDetails=true&status=running

Example 1

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

Response

{
    "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
    }]
}


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 Deployment and VM States 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 Deployment Environments 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 Benchmark Applications 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 Deployment and VM States 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
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 Manage Instance Types 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 Deployment Environments 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 Deployment Environment 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 
 provisionBareMetal 
  • Description: Identifies if the machines should be provisioned as bare metal hardware (see Provision Bare Metal Hardware Servers 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