Cluster Node Web Services

Owned by Stonebranch (Deactivated)
Last updated: Nov 08, 2024 by Alec Berger
5 min read

Overview

Universal Controller supports the following RESTful-based web services for Cluster Nodes, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

List All Cluster Nodes


Description

URI

http://host_name/uc/resources/clusternode/list

HTTP Method

GET

Description

Retrieves information on all Cluster Nodes.

Example URI

http://localhost:8080/uc/resources/clusternode/list

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List All Cluster Nodes: XML and JSON Examples.

Properties

See List All Cluster Nodes: Properties.

List All Cluster Nodes: XML and JSON Examples

XML

JSON

 XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<clusterNodes>
    <clusterNode>
        <buildDate>11-23-2023_1245</buildDate>
        <buildId>build.development</buildId>
        <hostName>MAC-LAP</hostName>
        <ipAddress>10.0.0.53</ipAddress>
        <nodeId>vvv:7080-ops</nodeId>
        <nodeMode>Passive</nodeMode>
        <nodeStart>2023-11-23 12:45:19</nodeStart>
        <nodeTs>2023-12-23 13:02:20</nodeTs>
        <nodeUptime>1020</nodeUptime>
        <nodeUptimeDisplay>17 Minutes 0 Seconds</nodeUptimeDisplay>
        <paused>false</paused>
        <pausedForMaintenance />
        <preferred>false</preferred>
        <relId>7.7.0.0</relId>
        <sysId>e49ff9705da6407caaa15de9c13ae9e6</sysId>
        <transitory>false</transitory>
    </clusterNode>
    <clusterNode>
        <buildDate>11-24-2023_1238</buildDate>
        <buildId>build.development</buildId>
        <hostName>MAC-LAP</hostName>
        <ipAddress>10.0.0.53</ipAddress>
        <nodeId>MAC-LAP:7080-ops</nodeId>
        <nodeMode>Active</nodeMode>
        <nodeStart>2023-11-24 12:38:06</nodeStart>
        <nodeTs>2023-11-27 09:23:33</nodeTs>
        <nodeUptime>247526</nodeUptime>
        <nodeUptimeDisplay>2 Days 20 Hours 45 Minutes 26 Seconds</nodeUptimeDisplay>
        <paused>false</paused>
        <pausedForMaintenance />
        <preferred>false</preferred>
        <relId>7.7.0.0</relId>
        <sysId>1cac01428a5a489aade6048ecd13771c</sysId>
        <transitory>true</transitory>
    </clusterNode>
</clusterNodes>
 JSON
[
    {
        "buildDate": "11-23-2023_1058",
        "buildId": "build.development",
        "hostName": "MAC-LAP",
        "ipAddress": "10.0.0.53",
        "nodeId": "zzz:7080-ops",
        "nodeMode": "Passive",
        "nodeStart": "2023-11-23 10:58:44",
        "nodeTs": "2023-12-23 12:37:55",
        "nodeUptime": 5950,
        "nodeUptimeDisplay": "1 Hour 39 Minutes 10 Seconds",
        "paused": false,
        "pausedForMaintenance": null,
        "preferred": false,
        "relId": "7.7.0.0",
        "sysId": "e2738159924c4ce7b867b585027e9dfc",
        "transitory": true
    },
    {
        "buildDate": "11-23-2023_1245",
        "buildId": "build.development",
        "hostName": "MAC-LAP",
        "ipAddress": "10.0.0.53",
        "nodeId": "vvv:7080-ops",
        "nodeMode": "Passive",
        "nodeStart": "2023-11-23 12:45:19",
        "nodeTs": "2023-12-23 13:02:20",
        "nodeUptime": 1020,
        "nodeUptimeDisplay": "17 Minutes 0 Seconds",
        "paused": false,
        "pausedForMaintenance": null,
        "preferred": false,
        "relId": "7.7.0.0",
        "sysId": "e49ff9705da6407caaa15de9c13ae9e6",
        "transitory": true
    },
    {
        "buildDate": "11-23-2023_0132",
        "buildId": "build.development",
        "hostName": "MAC-LAP",
        "ipAddress": "10.0.0.53",
        "nodeId": "MAC-LAP:7080-ops",
        "nodeMode": "Active",
        "nodeStart": "2023-11-23 13:32:54",
        "nodeTs": "2023-11-24 08:47:02",
        "nodeUptime": 69247,
        "nodeUptimeDisplay": "19 Hours 14 Minutes 7 Seconds",
        "paused": false,
        "pausedForMaintenance": null,
        "preferred": false,
        "relId": "7.7.0.0",
        "sysId": "8152d5e530134bb8a7b03567480aadbd",
        "transitory": false
    }
]

List All Cluster Nodes: Properties

Property

UI Field Name

Description

buildDate

Build Date

Build date for this cluster node.

buildId

Build Id

Build ID for this cluster node.

hostName

Host Name

IP address or domain/name of the host machine where the cluster node resides.

ipAddress

IP Address

IP address of this cluster node.

nodeId

Node Id

URL of the cluster node.

nodeMode

Mode

Current mode of the cluster node.

nodeStart

Start Time

Date and time this cluster node was last started.

nodeTs

Timestamp

Date and time of the last heartbeat of this cluster node.

nodeUptime

n/a

nodeUptimeDisplay (in seconds).

nodeUptimeDisplay

Uptime

Amount of time this cluster node has been running.

paused

Paused

Indication that the Controller has been paused.

pausedForMaintenance

n/a

Deprecated.   Indication that the Controller has been paused for maintenance.

relId

Release

Release number for this cluster node.

sysId

n/a

System ID field in the database for this cluster node record.

transitoryTransientSpecifies if this node is a transient Cluster Node. 

Read Current Cluster Node


Description

URI

http://host_name/uc/resources/clusternode/info

HTTP Method

GET

Description

Retrieves information on the current Cluster Node.

Example URI

http://localhost:8080/uc/resources/clusternode/info

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Response Example

See Read Current Cluster Node: XML and JSON Examples.

Properties

See List All Cluster Nodes: Properties.

Read Current Cluster Node: XML and JSON Examples

XML

JSON

 XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<clusterNode>
    <buildDate>11-24-2023_1238</buildDate>
    <buildId>build.development</buildId>
    <hostName>MAC-LAP</hostName>
    <ipAddress>10.0.0.53</ipAddress>
    <nodeId>MAC-LAP:7080-ops</nodeId>
    <nodeMode>Active</nodeMode>
    <nodeStart>2023-11-24 12:38:06</nodeStart>
    <nodeTs>2023-11-27 09:39:14</nodeTs>
    <nodeUptime>248467</nodeUptime>
    <nodeUptimeDisplay>2 Days 21 Hours 1 Minute 7 Seconds</nodeUptimeDisplay>
    <paused>false</paused>
    <pausedForMaintenance />
    <preferred>false</preferred>
    <relId>7.7.0.0</relId>
    <sysId>1cac01428a5a489aade6048ecd13771c</sysId>
    <transitory>true</transitory>
</clusterNode>
 JSON
{
    "buildDate": "11-24-2023_1238",
    "buildId": "build.development",
    "hostName": "MAC-LAP",
    "ipAddress": "10.0.0.53",
    "nodeId": "MAC-LAP:7080-ops",
    "nodeMode": "Active",
    "nodeStart": "2023-11-24 12:38:06",
    "nodeTs": "2023-11-27 09:37:14",
    "nodeUptime": 248347,
    "nodeUptimeDisplay": "2 Days 20 Hours 59 Minutes 7 Seconds",
    "paused": false,
    "pausedForMaintenance": null,
    "preferred": false,
    "relId": "7.7.0.0",
    "sysId": "1cac01428a5a489aade6048ecd13771c",
    "transitory": true
}