Getting Details of an Application

You can get details of an application using the CLI tool, REST API or the PPaaS Console as shown below:

Getting details of an application via the CLI

Overview

CLI command	`describe-application`
Description	Retrieve details of an application policy.
Command format	describe-application <APPLICATION_ID>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	Unique ID of the application	Yes	wso2am-190-application

Example

Retrieve details on the application named: wso2am-190-application.

describe-application wso2am-190-application

Sample output

Application: wso2am-190-application
{
  "applicationId": "wso2am-190-application",
  "multiTenant": true,
  "alias": "wso2am-190-application",
  "status": "Created",
  "components": {
    "groups": [
      {
        "name": "keymanager-gw-manager-gw-worker",
        "alias": "keymanager-gw-manager-gw-worker",
        "groupMinInstances": 1,
        "groupMaxInstances": 1,
        "cartridges": [
          {
            "type": "wso2am-190-gw-manager",
            "cartridgeMin": 1,
            "cartridgeMax": 1,
            "subscribableInfo": {
              "alias": "gateway-manager",
              "deploymentPolicy": "deployment-policy-1",
              "autoscalingPolicy": "autoscaling-policy-1",
              "maxMembers": 0,
              "minMembers": 0
            }
          },
          {
            "type": "wso2am-190-gw-worker",
            "cartridgeMin": 1,
            "cartridgeMax": 1,
            "subscribableInfo": {
              "alias": "gateway-worker",
              "deploymentPolicy": "deployment-policy-1",
              "autoscalingPolicy": "autoscaling-policy-1",
              "maxMembers": 0,
              "minMembers": 0
            }
          },
          {
            "type": "wso2am-190-km",
            "cartridgeMin": 1,
            "cartridgeMax": 1,
            "subscribableInfo": {
              "alias": "key-manager",
              "deploymentPolicy": "deployment-policy-1",
              "autoscalingPolicy": "autoscaling-policy-1",
              "maxMembers": 0,
              "minMembers": 0
            }
          }
        ]
      },
      {
        "name": "pub-store-grp",
        "alias": "pub-store-grp",
        "groupMinInstances": 1,
        "groupMaxInstances": 1,
        "cartridges": [
          {
            "type": "wso2am-190-pub",
            "cartridgeMin": 1,
            "cartridgeMax": 1,
            "subscribableInfo": {
              "alias": "publisher",
              "deploymentPolicy": "deployment-policy-1",
              "autoscalingPolicy": "autoscaling-policy-1",
              "maxMembers": 0,
              "minMembers": 0
            }
          },
          {
            "type": "wso2am-190-store",
            "cartridgeMin": 1,
            "cartridgeMax": 1,
            "subscribableInfo": {
              "alias": "store",
              "deploymentPolicy": "deployment-policy-1",
              "autoscalingPolicy": "autoscaling-policy-1",
              "maxMembers": 0,
              "minMembers": 0
            }
          }
        ]
      }
    ],
    "dependencies": {
      "startupOrders": [
        {
          "aliases": [
            "group.keymanager-gw-manager-gw-worker",
            "group.pub-store-grp"
          ]
        }
      ],
      "terminationBehaviour": "terminate-none"
    }
  },
  "signUpsExist": false
}

Getting details of an application via the REST API

Overview

Description	Retrieve details of a specific application.
Resource Path	`/applications/{applicationId}`
HTTP Method	`GET`
Request/Response Format	`application/json`
Command format	curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/applications/{applicationId} By default, `<USERNAME>:<PASSWORD>` is `admin:admin.` By default, `<PRIVATE_PAAS_HOST>` is `localhost.` However, if you are using a public IP, the respective IP address or domain needs to be specified. By default, `<PRIVATE_PAAS_HTTPS_PORT>` has been set to 9443. However, if the port offset has been incremented by `n`, the default port value needs to be incremented by `n`.

Example

Retrieve details on the application named : wso2am-190-application.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applications/wso2am-190-application

Sample output

> GET /api/applications/wso2am-190-application HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Mon, 12 Oct 2015 04:20:11 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"alias":"wso2am-190-application","applicationId":"wso2am-190-application","components":{"dependencies":{"startupOrders":[{"aliases":["group.keymanager-gw-manager-gw-worker","group.pub-store-grp"]}],"terminationBehaviour":"terminate-none"},"groups":[{"alias":"keymanager-gw-manager-gw-worker","cartridges":[{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"gateway-manager","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-gw-manager"},{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"gateway-worker","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-gw-worker"},{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"key-manager","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-km"}],"groupMaxInstances":1,"groupMinInstances":1,"name":"keymanager-gw-manager-gw-worker"},{"alias":"pub-store-grp","cartridges":[{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"publisher","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-pub"},{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"store","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-store"}],"groupMaxInstances":1,"groupMinInstances":1,"name":"pub-store-grp"}]},"multiTenant":true,"signUpsExist":false,"status":"Created"}Shavindris-MacBook-Air:samples shavindridissanayake$

You will come across the following HTTP status codes while getting the details of an application:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Getting details of an application via the PPaaS Console

Follow the instructions below to view details of an application:

Click Applications on the home page.
Hover your mouse pointer over the application you wish to view for the View button to appear and click View for the selected application topology to appear.

The selected application topology view is as follows:

As the application has not been deployed yet the nodes are flagged orange to indicate that it is in the created state.