getTopology

Purpose

Retrieves topology. Only a user with the Administrator role on the master tenant can execute this method.

HTTP Method

GET

URL

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login().

Permissions Required

Administrative privileges on the master tenant.

Response

Topology details in JSON format.

Example

Output example:

{
    "topology": [
        {
            "nodeName": "129e5305-0f2a-48ca-9a92-13b606ec36a4",
            "hostName": "localhost",
            "port": 8080,
            "components": [
                {
                    "componentName": "STORAGE",
                    "componentDisplayName": "STORAGE server",
                    "componentType": "STORAGE",
                    "internalURL": "http://localhost:8080/storage/",
                    "externalURL": "http://abc:8080/storage/",
                    "componentURL": "http://localhost:8080/storage/servlet/Component"
                },
                {
                    "componentName": "REST",
                    "componentDisplayName": "REST server",
                    "componentType": "REST",
                    "internalURL": "http://localhost:8080/rest/",
                    "externalURL": "http://abc.com:8080/rest/",
                    "componentURL": "http://localhost:8080/rest/servlet/Component"
                }                
            ]
        },
        {
            "nodeName": "6ded8814-d3cc-41b4-baa1-11f96df018b4",
            "hostName": "localhost",
            "port": 9180,
            "components": [
                {
                    "componentName": "PROD1",
                    "componentDisplayName": "PROD1 server",
                    "componentType": "PROD",
                    "internalURL": "http://localhost:9180/prod1/",
                    "externalURL": "http://abc.com:8080/prod1/",
                    "componentURL": "http://localhost:9180/prod1/servlet/Component",
                    "power": 1,
                    "isDedicated": false
                }
            ]
        },
        {
            "nodeName": "b369e4a2-adaf-4571-97ee-1e762a770eac",
            "hostName": "localhost",
            "port": 9080,
            "components": [
                {
                    "componentName": "PROD1",
                    "componentDisplayName": "PROD1 server",
                    "componentType": "PROD",
                    "internalURL": "http://localhost:9080/prod1/",
                    "externalURL": "http://abc.com:8080/prod1/",
                    "componentURL": "http://localhost:9080/prod1/servlet/Component",
                    "power": 1,
                    "isDedicated": false
                }
            ]
        }
    ]
}