This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • 4.1.x Getting the Runtime Topology of an Application via REST API
Skip to end of metadata
Go to start of metadata

Overview

DescriptionRetrieve the runtime topology of an application.
Resource Path/applications/{applicationId}/runtime
HTTP MethodGET
Request/Response Formatapplication/json
> GET /api/applications/single-group-v3/runtime HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 200 OK
< Date: Mon, 30 Mar 2015 11:49:19 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"id":"single-group-v3","status":"Inactive","tenantAdminUsername":"admin","tenantDomain":"carbon.super"}
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/applications/{applicationId}/runtime

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_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.

For example:

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applications/single-group-v3/runtime
CLI command

describe-application-runtime

DescriptionRetrieve the runtime topology of an application.
Command format

describe-application-runtime single-cartridge-app


REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

{
  "id": "single-group-v3",
  "status": "Inactive",
  "tenantAdminUsername": "admin",
  "tenantDomain": "carbon.super"
}
  • No labels