Getting the Runtime Topology of an Application

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

Getting the runtime topology of an application via the CLI

Overview

CLI command	`describe-application-runtime`
Description	Retrieve the runtime topology of an application.
Command format	describe-application-runtime <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 the runtime topology of an application named: wso2am-190-application.

describe-application-runtime wso2am-190-application

Sample output

Application: wso2am-190-application
{
  "multiTenant": false,
  "status": "Active",
  "signUpsExist": false
}

Getting the run time topology of an application via the REST API

Overview

Description	Retrieve the runtime topology of an application.
Resource Path	`/applications/{applicationId}/runtime`
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}/runtime 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 the runtime topology of an 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/runtime

Sample output

> GET /api/applications/wso2am-190-application/runtime 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 05:26:26 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"applicationInstances":[{"applicationId":"wso2am-190-application","groupInstances":[{"clusterInstances":[{"alias":"gateway-worker","clusterId":"wso2am-190-application.gateway-worker.wso2am-190-gw-worker.domain","hostNames":["wso2am-190-application.gw.am.wso2.org"],"instanceId":"wso2am-190-application-1","member":[{"clusterId":"wso2am-190-application.gateway-worker.wso2am-190-gw-worker.domain","clusterInstanceId":"wso2am-190-application-1","defaultPrivateIP":"10.0.0.49","defaultPublicIP":"20.0.0.49","memberId":"wso2am-190-application.gateway-worker.wso2am-190-gw-worker.domain696cd583-ea99-4dde-ad59-73e8ef4f010f","memberPrivateIPs":"10.0.0.49","memberPublicIPs":"20.0.0.49","networkPartitionId":"network-partition-mock","partitionId":"partition-2","ports":[{"port":8243,"protocol":"https","proxyPort":0}],"property":[{"name":"MIN_COUNT","value":1}],"serviceName":"wso2am-190-gw-worker","status":"Active"}],"parentInstanceId":"wso2am-190-application-1","serviceName":"wso2am-190-gw-worker","status":"Inactive","tenantRange":"*"},{"alias":"gateway-manager","clusterId":"wso2am-190-application.gateway-manager.wso2am-190-gw-manager.domain","hostNames":["wso2am-190-application.gwmgt.am.wso2.org"],"instanceId":"wso2am-190-application-1","member":[{"clusterId":"wso2am-190-application.gateway-manager.wso2am-190-gw-manager.domain","clusterInstanceId":"wso2am-190-application-1","defaultPrivateIP":"10.0.0.50","defaultPublicIP":"20.0.0.50","memberId":"wso2am-190-application.gateway-manager.wso2am-190-gw-manager.domaind62dc506-195e-4fd2-8a60-c24e73ef14ca","memberPrivateIPs":"10.0.0.50","memberPublicIPs":"20.0.0.50","networkPartitionId":"network-partition-mock","partitionId":"partition-2","ports":[{"port":9763,"protocol":"http","proxyPort":0}],"property":[{"name":"MIN_COUNT","value":1}],"serviceName":"wso2am-190-gw-manager","status":"Active"}],"parentInstanceId":"wso2am-190-application-1","serviceName":"wso2am-190-gw-manager","status":"Inactive","tenantRange":"*"},{"alias":"key-manager","clusterId":"wso2am-190-application.key-manager.wso2am-190-km.domain","hostNames":["wso2am-190-application.keymanager.am.wso2.org"],"instanceId":"wso2am-190-application-1","member":[{"clusterId":"wso2am-190-application.key-manager.wso2am-190-km.domain","clusterInstanceId":"wso2am-190-application-1","defaultPrivateIP":"10.0.0.48","defaultPublicIP":"20.0.0.48","memberId":"wso2am-190-application.key-manager.wso2am-190-km.domainb0c940c9-a24a-4493-974d-8e2e3da82b2f","memberPrivateIPs":"10.0.0.48","memberPublicIPs":"20.0.0.48","networkPartitionId":"network-partition-mock","partitionId":"partition-2","ports":[{"port":9763,"protocol":"http","proxyPort":0}],"property":[{"name":"MIN_COUNT","value":1}],"serviceName":"wso2am-190-km","status":"Active"}],"parentInstanceId":"wso2am-190-application-1","serviceName":"wso2am-190-km","status":"Inactive","tenantRange":"*"}],"groupId":"keymanager-gw-manager-gw-worker","instanceId":"wso2am-190-application-1","parentInstanceId":"wso2am-190-application-1","status":"Inactive"},{"clusterInstances":[{"alias":"store","clusterId":"wso2am-190-application.store.wso2am-190-store.domain","hostNames":["wso2am-190-application.store.am.wso2.org"],"instanceId":"wso2am-190-application-1","member":[{"clusterId":"wso2am-190-application.store.wso2am-190-store.domain","clusterInstanceId":"wso2am-190-application-1","defaultPrivateIP":"10.0.0.46","defaultPublicIP":"20.0.0.46","memberId":"wso2am-190-application.store.wso2am-190-store.domain3ab8bd2a-470c-4bbe-b851-53b33fa9ee84","memberPrivateIPs":"10.0.0.46","memberPublicIPs":"20.0.0.46","networkPartitionId":"network-partition-mock","partitionId":"partition-2","ports":[{"port":9763,"protocol":"http","proxyPort":0}],"property":[{"name":"MIN_COUNT","value":1}],"serviceName":"wso2am-190-store","status":"Active"}],"parentInstanceId":"wso2am-190-application-1","serviceName":"wso2am-190-store","status":"Inactive","tenantRange":"*"},{"alias":"publisher","clusterId":"wso2am-190-application.publisher.wso2am-190-pub.domain","hostNames":["wso2am-190-application.publisher.am.wso2.org"],"instanceId":"wso2am-190-applicat* Connection #0 to host localhost left intact
ion-1","member":[{"clusterId":"wso2am-190-application.publisher.wso2am-190-pub.domain","clusterInstanceId":"wso2am-190-application-1","defaultPrivateIP":"10.0.0.47","defaultPublicIP":"20.0.0.47","memberId":"wso2am-190-application.publisher.wso2am-190-pub.domaine6bd0594-4d81-4e4e-a7d9-f35ba043e816","memberPrivateIPs":"10.0.0.47","memberPublicIPs":"20.0.0.47","networkPartitionId":"network-partition-mock","partitionId":"partition-2","ports":[{"port":9763,"protocol":"http","proxyPort":0}],"property":[{"name":"MIN_COUNT","value":1}],"serviceName":"wso2am-190-pub","status":"Active"}],"parentInstanceId":"wso2am-190-application-1","serviceName":"wso2am-190-pub","status":"Inactive","tenantRange":"*"}],"groupId":"pub-store-grp","instanceId":"wso2am-190-application-1","parentInstanceId":"wso2am-190-application-1","status":"Inactive"}],"instanceId":"wso2am-190-application-1","status":"Inactive"}],"id":"wso2am-190-application","status":"Inactive","tenantAdminUsername":"admin","tenantDomain":"carbon.super"}

You will come across the following HTTP status codes while adding an application:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Location header URL

https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/applications/<APPLICATION_ID>

Getting the runtime topology of an application via the PPaaS Console

Follow the instructions below to get the runtime topology of an application:

Click Applications on the home page.
Hover your mouse pointer over the application, which you wish to view, for the View button to appear and click View.
The topology view of the application appears. Move your mouse-pointer over the respective clusters to get runtime details of the cluster.

The topology view provides the overview of the state of an application and it's dependencies. The cluster ID, cluster alias, access URL, hostname and service name will be unique among clusters.
For example, wso2as521-worker is shown in green to indicate that it is in the active state as indicated in the Legends information pane.