Get Application Details

Details

API Details
NameGet Application Details
DescriptionRetrieve details of an application for a specific version. If no version is specified, this API retrieves details of the latest version.  
MethodGET
URI
  • /v1/apps/appId?version=appVersion
  • /v1/apps/appId
CloudCenter Release
  • CloudCenter 3.x and 4.x
  • Enhanced in CloudCenter 4.1.2 to include the serviceTiers.hwprofile attributes
  • Enhanced in CloudCenter 4.2 to:
    • Change category to profileCategory
    • Include the logoPath and appCategories attributes
  • The supportsCuda and cudaSupport attributes are deprecated in CloudCenter 4.7.2.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Header
  • action: get.apps.appId
    actionparam: version=appVersion
  • action: get.apps/appId

Example 1 – /v1/apps/appId?version=appVersion

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/apps/1212?version=3.1"

Response

{
  "id": "1212",
  "name": "BlogEngine 2008",
  "description": "Open Source blog engine built on .NET\nAdmin User Details:\nuser: admin password: admin",
  "version": "3.1",
  "revisionId": 3,
  "serviceTierId": "BlogEngine2008-1212",
  "executor": "NTierExecutor",
  "profileCategory": "NTier",
  "logoPath": "/assets/img/appLogo/1212/logo.png",
  "hwprofile": null,
  "serviceTiers": [
    {
      "id": "1213",
      "name": "IIS",
      "description": null,
      "version": "3.1",
      "revisionId": 0,
      "serviceTierId": "iis-1213",
      "executor": null,
      "profileCategory": null,
      "logoPath": "/assets/vendors/1/img/DefaultApp.png",
      "hwprofile": {
        "memorySize": 1024,
        "numOfCPUs": 1,
        "networkSpeed": null,
        "numOfNICs": 1,
        "localStorageCount": 0,
        "localStorageSize": 10,
        "cudaSupport": false,
        "ssdSupport": false,
        "supportHardwareProvision": false
      },
      "serviceTiers": [],
      "parameters": {
        "appParams": [
          {
            "name": "cliqrWebServerType",
            "value": "iis"
          },
          {
            "name": "tierOrder",
            "value": "1"
          },
          {
            "name": "defaultService",
            "value": ""
          },
          {
            "name": "minClusterSize",
            "value": "1"
          },
          {
            "name": "maxClusterSize",
            "value": "2"
          },
          {
            "name": "cliqrNoOfVolumes",
            "value": "0"
          },
          {
            "name": "cliqrDBDataStorageSize",
            "value": ""
          },
          {
            "name": "cliqrIISDOTNETVER",
            "value": "4.0"
          },
          {
            "name": "cliqrIISAppPkg",
            "value": "%REPO_ID_1%blogEng/blogEng3.1.zip"
          },
          {
            "name": "cliqrIISAppAlias",
            "value": "blogengine"
          },
          {
            "name": "cliqrIISPoolName",
            "value": "DefaultAppPool"
          },
          {
            "name": "cliqrIisConfigFiles",
            "value": ""
          },
          {
            "name": "appMigrationFiles",
            "value": "cliqrIISAppPkg"
          },
          {
            "name": "OSSVC_HOME",
            "value": "C:\\Progra~1\\osmosix\\service"
          },
          {
            "name": "cliqrIisPreStartAction",
            "value": ""
          },
          {
            "name": "cliqrIisPostStartAction",
            "value": ""
          },
          {
            "name": "cliqrIisPreStopAction",
            "value": ""
          },
          {
            "name": "cliqrIisPostStopAction",
            "value": ""
          },
          {
            "name": "resumeScript",
            "value": ""
          },
          {
            "name": "topTier",
            "value": "true"
          }
        ],
        "envParams": []
      },
      "parameterSpecs": {
        "systemParams": {
          "params": [
            {
              "paramName": "cliqrWebServerType",
              "displayName": null,
              "helpText": null,
              "type": "string",
              "valueList": null,
              "defaultValue": "iis",
              "userVisible": false,
              "userEditable": false,
              "systemParam": true,
              "exampleValue": null,
              "dataUnit": null,
              "optional": false,
              "valueConstraint": null,
              "scope": null,
              "webserviceListParams": null,
              "collectionList": []
            },
            ...
            {
              "paramName": "cliqrIISPoolName",
              "displayName": "IIS Application Pool",
              "helpText": "IIS Application Pool to which the Application is deployed",
              "type": "string",
              "valueList": null,
              "defaultValue": "DefaultAppPool",
              "userVisible": true,
              "userEditable": true,
              "systemParam": true,
              "exampleValue": null,
              "dataUnit": null,
              "optional": false,
              "valueConstraint": {
                "minValue": 0,
                "maxValue": 0,
                "maxLength": 255,
                "regex": null,
                "allowSpaces": true,
                "sizeValue": 0,
                "step": 0,
                "calloutWorkflowName": null
              },
              "scope": null,
              "webserviceListParams": null,
              "collectionList": []
            },
            {
              "paramName": "cliqrIisConfigFiles",
              "displayName": "App Config files",
              "helpText": "Application config files that contain system tokens
 and will be modified at deployment time. The config file is a relative path from
 the webapp context folder, e.g., db.conf. If there are multiple files, separate
 with semicolon.",
              "type": "string",
              "valueList": null,
              "defaultValue": "",
              "userVisible": true,
              "userEditable": true,
              "systemParam": true,
              "exampleValue": null,
              "dataUnit": null,
              "optional": true,
              "valueConstraint": {
                "minValue": 0,
                "maxValue": 0,
                "maxLength": 255,
                "regex": null,
                "allowSpaces": true,
                "sizeValue": 0,
                "step": 0,
                "calloutWorkflowName": null
              },
              "scope": null,
              "webserviceListParams": null,
              "collectionList": []
            },
            ...
            {
              "paramName": "topTier",
              "displayName": "topTier",
              "helpText": null,
              "type": "boolean",
              "valueList": null,
              "defaultValue": "true",
              "userVisible": false,
              "userEditable": false,
              "systemParam": true,
              "exampleValue": null,
              "dataUnit": null,
              "optional": false,
              "valueConstraint": null,
              "scope": null,
              "webserviceListParams": null,
              "collectionList": []
            }
          ],
          "size": null
        },
        "customParams": {
          "params": [],
          "size": null
        },
        "envVars": {
          "envVars": [],
          "size": null
        }
      },
      "supportedClouds": [
        {
          "id": "Amazon-eu-west-1",
          "resource": "https://c4beta.cliqrtech.com/v1/apps/1213/cloudConfigs/Amazon-eu-west-1?version=3.1",
          "perms": []
        },
        ...
        {
          "id": "HpCloud-region-a-geo-1",
          "resource": "https://c4beta.cliqrtech.com/v1/apps/1213/cloudConfigs/HpCloud-region-a-geo-1?version=3.1",
          "perms": []
        }
      ],
      "appCategories": []
    }
  ],
  "parameters": {
    "appParams": [
      {
        "name": "cliqrWebappAccessLink",
        "value": "blogengine"
      },
      {
        "name": "cliqrExternalHttpsEnabled",
        "value": "0"
      },
      {
        "name": "cliqrExternalHttpEnabled",
        "value": "1"
      },
      {
        "name": "cliqrExternalNoProtocolEnabled",
        "value": "0"
      },
      {
        "name": "cliqrForceHttpRedirect",
        "value": "0"
      },
      {
        "name": "useNonStandardPort",
        "value": "0"
      },
      {
        "name": "cliqrNonStandardPort",
        "value": ""
      },
      {
        "name": "microSegmentation",
        "value": "0"
      },
      {
        "name": "appPackage",
        "value": ""
      },
      {
        "name": "OSSVC_HOME",
        "value": "/usr/local/osmosix/service"
      },
      {
        "name": "cliqrAppType",
        "value": "n-tier"
      },
      {
        "name": "cliqrUseCustomCert",
        "value": "0"
      },
      {
        "name": "cliqrSSLCert",
        "value": ""
      },
      {
        "name": "cliqrSSLKey",
        "value": ""
      }
    ],
    "envParams": []
  },
  "parameterSpecs": {
    "systemParams": {
      "params": [
        {
          "paramName": "cliqrWebappAccessLink",
          "displayName": null,
          "helpText": null,
          "type": "string",
          "valueList": null,
          "defaultValue": "blogengine",
          "userVisible": true,
          "userEditable": true,
          "systemParam": true,
          "exampleValue": null,
          "dataUnit": null,
          "optional": false,
          "valueConstraint": null,
          "scope": null,
          "webserviceListParams": null,
          "collectionList": []
        },
        ...
        {
          "paramName": "cliqrSSLKey",
          "displayName": "SSL Key location",
          "helpText": null,
          "type": null,
          "valueList": null,
          "defaultValue": "",
          "userVisible": false,
          "userEditable": false,
          "systemParam": true,
          "exampleValue": null,
          "dataUnit": null,
          "optional": false,
          "valueConstraint": null,
          "scope": null,
          "webserviceListParams": null,
          "collectionList": []
        }
      ],
      "size": null
    },
    "customParams": {
      "params": [],
      "size": null
    },
    "envVars": {
      "envVars": [],
      "size": null
    }
  },
  "supportedClouds": [
    {
      "id": "Amazon-eu-west-1",
      "resource": "https://c4beta.cliqrtech.com/v1/apps/1213/cloudConfigs/
Amazon-eu-west-1?version=3.1",
      "perms": []
    },
    {
      "id": "SoftLayer-sjc01",
      "resource": "https://c4beta.cliqrtech.com/v1/apps/1213/cloudConfigs/
SoftLayer-sjc01?version=3.1",
      "perms": []
    },
    ...
    {
      "id": "Google-us-central1",
      "resource": "https://c4beta.cliqrtech.com/v1/apps/1213/cloudConfigs/
Google-us-central1?version=3.1",
      "perms": []
    }
  ],
  "appCategories": []
}

Example 2 – /v1/apps/appId

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

Response

{
    "id": "1337",
    "name": "App_MultiStep_1",
    "description": "A Mult-Step Execute Command",
    "version": "MA-v1.0-U1204",
    "revisionId": 2,
    "serviceTierId": "App_MultiStep_1-1337",
    "executor": "seqWflExecutor",
    "profileCategory": "JobBased",
    "logoPath": "/assets/img/appLogo/1337/logo.png",
    "hwprofile": {
        "memorySize": 512,
        "numOfCPUs": 1,
        "networkSpeed": null,
        "numOfNICs": 1,
        "localStorageCount": 0,
        "localStorageSize": 10,
        "cudaSupport": false,
        "ssdSupport": false,
        "supportHardwareProvision": false
    },
    "serviceTiers": [{
        "id": "1338",
        "name": "PRL",
        "description": "Parallel Execution",
        "version": "MA-v1.0-U1204",
        "revisionId": 0,
        "serviceTierId": "PRL-1338",
        "executor": null,
        "profileCategory": null,
        "logoPath": "/assets/vendors/1/img/DefaultApp.png",
        "hwprofile": {
            "memorySize": 512,
            "numOfCPUs": 1,
            "networkSpeed": null,
            "numOfNICs": 1,
            "localStorageCount": 0,
            "localStorageSize": 10,
            "cudaSupport": false,
            "ssdSupport": false,
            "supportHardwareProvision": false
        },
        "serviceTiers": [],
        "parameters": {
            "appParams": [{
                "name": "NumNodes",
                "value": "1"
            }, {
                "name": "OutputDir",
                "value": "%OUTPUT_DIR%/%DATE%/%JOB_NAME%"
            }],
            "envParams": []
        },
        "parameterSpecs": {
            "systemParams": {
                "params": [],
                "size": null
            },
            "customParams": {
                "params": [{
                    "paramName": "NumNodes",
                    "displayName": "NumNodes",
                    "helpText": "",
                    "type": "number",
                    "valueList": null,
                    "defaultValue": "1",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": false,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 255,
                        "maxLength": 0,
                        "regex": null,
                        "allowSpaces": true,
                        "sizeValue": 0,
                        "step": 0,
                        "calloutWorkflowName": null
                    },
                    "scope": null,
                    "webserviceListParams": null,
                    "collectionList": []
                }, {
                    "paramName": "OutputDir",
                    "displayName": "Output Directory",
                    "helpText": "Output Directory",
                    "type": "string",
                    "valueList": null,
                    "defaultValue": "%OUTPUT_DIR%/%DATE%/%JOB_NAME%",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": false,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 0,
                        "maxLength": 255,
                        "regex": null,
                        "allowSpaces": true,
                        "sizeValue": 0,
                        "step": 0,
                        "calloutWorkflowName": null
                    },
                    "scope": null,
                    "webserviceListParams": null,
                    "collectionList": []
                }],
                "size": null
            },
            "envVars": {
                "envVars": [],
                "size": null
            }
        },
        "supportedClouds": [{
            "id": "Amazon-eu-west-1",
            "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/Amazon-eu-west-1?version=MA-v1.0-U1204",
            "perms": []
        }, 
        ...
        {
            "id": "HpCloud-region-a-geo-1",
            "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/HpCloud-region-a-geo-1?version=MA-v1.0-U1204",
            "perms": []
        }],
        "appCategories": []
    }, {
        "id": "1339",
        "name": "BTCH",
        "description": "Batch Execution",
        "version": "MA-v1.0-U1204",
        "revisionId": 0,
        "serviceTierId": "BTCH-1339",
        "executor": null,
        "profileCategory": null,
        "logoPath": "/assets/vendors/1/img/DefaultApp.png",
        "hwprofile": {
            "memorySize": 512,
            "numOfCPUs": 1,
            "networkSpeed": null,
            "numOfNICs": 1,
            "localStorageCount": 0,
            "localStorageSize": 10,
            "cudaSupport": false,
            "ssdSupport": false,
            "supportHardwareProvision": false
        },
        "serviceTiers": [],
        "parameters": {
            "appParams": [{
                "name": "NumNodes",
                "value": "1"
            }, {
                "name": "UseBatchTaskList",
                "value": "0"
            }, {
                "name": "NumTasks",
                "value": ""
            }, {
                "name": "NumTasksPerNode",
                "value": "1"
            }, {
                "name": "OutputDir",
                "value": "%OUTPUT_DIR%/%DATE%/%JOB_NAME%"
            }],
            "envParams": []
        },
        "parameterSpecs": {
            "systemParams": {
                "params": [],
                "size": null
            },
            "customParams": {
                "params": [{
                    "paramName": "NumNodes",
                    "displayName": "NumNodes",
                    "helpText": "",
                    "type": "number",
                    "valueList": null,
                    "defaultValue": "1",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": false,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 255,
                        "maxLength": 0,
                        "regex": null,
                        "allowSpaces": true,
                        "sizeValue": 0,
                        "step": 0,
                        "calloutWorkflowName": null
                    },
                    "scope": null,
                    "webserviceListParams": null,
                    "collectionList": []
                }, 
                ...
                {
                    "paramName": "OutputDir",
                    "displayName": "Output Directory",
                    "helpText": "Output Directory",
                    "type": "string",
                    "valueList": null,
                    "defaultValue": "%OUTPUT_DIR%/%DATE%/%JOB_NAME%",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": false,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 0,
                        "maxLength": 255,
                        "regex": null,
                        "allowSpaces": true,
                        "sizeValue": 0,
                        "step": 0,
                        "calloutWorkflowName": null
                    },
                    "scope": null,
                    "webserviceListParams": null,
                    "collectionList": []
                }],
                "size": null
            },
            "envVars": {
                "envVars": [],
                "size": null
            }
        },
        "supportedClouds": [{
            "id": "Amazon-eu-west-1",
            "resource": "https://c4beta.cliqrtech.com/v1/apps/1339/cloudConfigs/Amazon-eu-west-1?version=MA-v1.0-U1204",
            "perms": []
        }, ...
        {
            "id": "HpCloud-region-a-geo-1",
            "resource": "https://c4beta.cliqrtech.com/v1/apps/1339/cloudConfigs/HpCloud-region-a-geo-1?version=MA-v1.0-U1204",
            "perms": []
        }],
        "appCategories": []
    }],
    "parameters": {
        "appParams": [],
        "envParams": []
    },
    "parameterSpecs": {
        "systemParams": {
            "params": [],
            "size": null
        },
        "customParams": {
            "params": [],
            "size": null
        },
        "envVars": {
            "envVars": [],
            "size": null
        }
    },
    "supportedClouds": [{
        "id": "Amazon-eu-west-1",
        "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/
Amazon-eu-west-1?version=MA-v1.0-U1204",
        "perms": []
    }, {
        "id": "SoftLayer-sjc01",
        "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/
SoftLayer-sjc01?version=MA-v1.0-U1204",
        "perms": []
    }, {
        "id": "Openstack-USDC",
        "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/
Openstack-USDC?version=MA-v1.0-U1204",
        "perms": []
    }, {
        "id": "VMware-US-DC",
        "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/
VMware-US-DC?version=MA-v1.0-U1204",
        "perms": []
    }, ...
       {
        "id": "Google-us-central1",
        "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/
Google-us-central1?version=MA-v1.0-U1204",
        "perms": []
    }, {
        "id": "HpCloud-region-a-geo-1",
        "resource": "https://c4beta.cliqrtech.com/v1/apps/1338/cloudConfigs/
HpCloud-region-a-geo-1?version=MA-v1.0-U1204",
        "perms": []
    }],
    "appCategories": []
}

 

Request Attributes

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

Response Attributes

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

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

version
  • Description: The application build version.

  • Type: String

revisionId
  • Description: Unique, system-generated identifier for the application revision version
  • Type: String

serviceTierId
  • Description: Unique, system-generated identifier for the service tier within the application. You can obtain the value for this ID by issuing the Get Job Details API (for example, Loadbalancer, database, AppCluster, or other tiers). This value is a concatenation of the Application Profile Type Name and the App ID.
  • Type: String

hwprofile (click for additional context)

serviceTiers (click for additional context)
parameters (click for additional context)
supportedClouds
  • Description: List of URLs to retrieve details of Cloud configurations supported for the app
  • Type: List

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

    • Type: String
    resource
    • Description: Unique URL to access this resource
    • Type: String
appCategories
  • Description: Identifies the application category details
    Type: Array of application categories

    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

    type
    • Description: Identifies how the category was selected for this application
    • Type: Enumeration

      EnumerationDescription
      PROFILESelected by Importing the Profile 
      APPSelected using a pre-existing Application
      APPSTORESelected using a Marketplace application

profileCategory  
  • Description: Identifies the application profile category for this Application Profile.
  • Type: Enumeration

    EnumerationDescription
    NTIERAn application with multiple tiers − each tier may be provisioned on a different server or cluster of servers
    LEGACYJob-based applications:
    • Batch — Non-real-time, single-server applications).
    • Cluster — Applications that require a cluster setup with shared file storage to complete the deployment.
    • Parallel — Single-server applications.
    • Multi-Step — Applications that contain multiple steps in the same tier.
    • Hadoop — Applications using the Hadoop framework
    INTERACTIVEDesktop applications that have a GUI interface
    SAASApplications using a single portal (CloudCenter APIs) to launch or model SaaS and traditional applications by specifying additional parameters.
logoPath
  • Type: String