clusterMembers


URI

<managerRoot uri>/clustermembers[.<format>]

Supported methods

GET, HEAD

Parent resource

managerRoot

Introduction

clusterMembers is the cluster member info resource. You can get all child nodes info of the current cluster through the clusterMembers resource.

Supported output formats: rjson, json, html, xml.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.

http://supermapiserver:8090/iserver/manager/clustermembers.rjson

GET request

Gets the all the child nodes information of the current cluster.

Response structure

Performing a GET request on the clusterMembers resource returns a list of cluster child nodes, each one with the following representation structure:

Field Type Description
active boolean Whether the cluster nodes active.
agentId String The id of agent node.
authorized boolean Whether the cluster nodes are authorized.
hostName String The computer name of the cluster nodes.
id String The id of cluster child node.
ip String The ip of cluster child node.
isAgent boolean Whether the cluster node is the node.
isControllable boolean Whether the cluster child node joined the cluster in the controlled way.
isOffLine boolean Whether the cluster node is offline.
isTileWorker boolean Whether the cluster node is the tiles node.
port int The port of cluster child node.
uriRoot String The service address of the cluster child nodes.

Response example

The returned rjson format representation after implementing the GET request on the service clusterMembers resource  http://localhost:8090/iserver/manager/clustermembers.rjson is as follows:

[

    {

        "active": true,

        "agentId": null,

        "authorized": true,

        "hostName": "HOST1",

        "id": "e0dec207b2e547f3bf908327fab03585",

        "ip": "192.168.17.149",

        "isAgent": false,

        "isControllable": false,

        "isOffLine": false,

        "isTileWorker": false,

        "port": 8091,

        "uriRoot": "http://192.168.17.149:8091/iserver/services"

    },

    {

        "active": true,

        "agentId": null,

        "authorized": true,

        "hostName": "HOST2",

        "id": "d7c64eb1ea1a4f11983082488ab9fba9",

        "ip": "192.168.17.148",

        "isAgent": false,

        "isControllable": false,

        "isOffLine": false,

        "isTileWorker": false,

        "port": 8090,

        "uriRoot": "http://192.168.17.148:8090/iserver/services"

    }

]

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the clusterMembers resource exists, or if the clusterMembers resource can be accessed by clients. It can also determine if the clusterMembers resource supports an output format <format> if performed on a URI with .<format> included.

See