Skip to main content

Cluster Node Web Services

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.

Cluster Node - Healthcheck​

Description

URI

http://host_name/uc/resources/clusternode/healthcheck

HTTP Method

GET

Description

Retrieves health check details of the current Cluster Node.

Example URI

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

Authentication

None

Produces Content-Type

application/json

Example Responses

  • Status 200 (Successful response)
    • Cluster Node is healthy
      JSON
      JSON
      {
          "info": [
              {
                  "message": "Universal Controller is healthy."
              },
              {
                  "message": "The last heartbeat was at Tue, Aug 04, 2025 13:45:56 EDT -0400."
              }
          ],
          "clusterNode": {
              "buildDate": "08-04-2025_0137",
              "buildId": "build.development",
              "nodeId": "STBUS220:8080-opswise78",
              "nodeMode": "Active",
              "nodeStart": "2025-08-04 13:37:55",
              "nodeTs": "2025-08-04 13:45:56",
              "nodeUptime": 481,
              "nodeUptimeDisplay": "8 Minutes 1 Seconds",
              "paused": false,
              "pausedForMaintenance": null,
              "preferred": false,
              "relId": "8.0.0.0",
              "transitory": false
          }
      }
  • Status 503 (Service Unavailable Response)
    • Cluster Node is unhealthy
      JSON
      JSON
      {
          "errors": [
              {
                  "message": "Universal Controller is unhealthy."
              },
              {
                  "message": "The last heartbeat was at Tue, Aug 04, 2025 13:46:56 EDT -0400."
              }
          ],
          "clusterNode": {
              "buildDate": "08-04-2025_0137",
              "buildId": "build.development",
              "nodeId": "STBUS220:8080-opswise78",
              "nodeMode": "Offline",
              "nodeStart": "2025-08-04 13:37:55",
              "nodeTs": "2025-08-04 13:46:56",
              "nodeUptime": 541,
              "nodeUptimeDisplay": "9 Minutes 1 Seconds",
              "paused": false,
              "pausedForMaintenance": null,
              "preferred": false,
              "relId": "8.0.0.0",
              "transitory": false
          }
      }

Properties

See Cluster Node Properties.

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 Cluster Node Properties.

List All Cluster Nodes: XML and JSON Examples​

JSON
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": "8.0.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": "8.0.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": "8.0.0.0",
        "sysId": "8152d5e530134bb8a7b03567480aadbd",
        "transitory": false
    }
]

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 Cluster Node Properties.

Read Current Cluster Node: XML and JSON Examples​

JSON
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": "8.0.0.0",
    "sysId": "1cac01428a5a489aade6048ecd13771c",
    "transitory": true
}

Properties​

Cluster Node 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.

preferred

Preferred

Indication that this cluster node is set as Preferred. The preferred node will always be the Active node if it is running.

relId

Release

Release number for this cluster node.

sysId

n/a

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

transitory

Transient

Specifies if this node is a transient Cluster Node.