Cluster Node Web Services
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 Method | GET |
Description | Retrieves information on all Cluster Nodes. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Properties |
List All Cluster Nodes: XML and JSON Examples
XML | JSON |
|---|---|
<clusterNodes>
<clusterNode>
<buildDate>12-18-2017_0529</buildDate>
<buildId>build.development</buildId>
<hostName>asus-pc</hostName>
<ipAddress>192.168.1.21</ipAddress>
<nodeId>asus-pc:8501-uc</nodeId>
<nodeMode>Active</nodeMode>
<nodeStart>2017-12-18 18:40:25</nodeStart>
<nodeTs>2017-12-19 09:55:46</nodeTs>
<nodeUptime>54920</nodeUptime>
<nodeUptimeDisplay>15 Hours 15 Minutes 20 Seconds</nodeUptimeDisplay>
<paused>false</paused>
<pausedForMaintenance />
<relId>6.4.3.0</relId>
<syslId>3a5385a3f6df47cb8eb7a2e29845d55b</syslId>
</clusterNode>
<clusterNode>
<buildDate>12-18-2017_0629</buildDate>
<buildId>build.development</buildId>
<hostName>atut-pc</hostName>
<ipAddress>192.168.1.22</ipAddress>
<nodeId>asus-pc:8502-uc</nodeId>
<nodeMode>Active</nodeMode>
<nodeStart>2017-12-18 19:40:25</nodeStart>
<nodeTs>2017-12-19 10:55:46</nodeTs>
<nodeUptime>54930</nodeUptime>
<nodeUptimeDisplay>16 Hours 15 Minutes 20 Seconds</nodeUptimeDisplay>
<paused>false</paused>
<pausedForMaintenance />
<relId>6.4.3.0</relId>
<syslId>3a5385a3f6df47cb8eb7a2e29845d55c</syslId>
</clusterNode>
</clusterNodes>
| [ {
"buildDate": "12-18-2017_0529",
"buildId": "build.18",
"hostName": "Mark-4",
"ipAddress": "192.168.1.21",
"nodeId": "Mark-4:8080-uc6",
"nodeMode": "Active",
"nodeStart": "2017-12-18 18:40:25",
"nodeTs": "2017-12-19 09:55:46",
"nodeUptime": 54920,
"nodeUptimeDisplay": "15 Hours 15 Minutes 20 Seconds",
"paused": false,
"pausedForMaintenance": null,
"relId": "6.4.3.0",
"syslId": "93ac346868fc4171a514d1d0b02487e1"
},
{
"buildDate": "12-18-2017_0629",
"buildId": "build.18",
"hostName": "Mark-5",
"ipAddress": "192.168.1.22",
"nodeId": "Mark-5:8080-uc6",
"nodeMode": "Active",
"nodeStart": "2017-12-18 19:40:25",
"nodeTs": "2017-12-19 10:55:46",
"nodeUptime": 54930,
"nodeUptimeDisplay": "16 Hours 15 Minutes 20 Seconds",
"paused": false,
"pausedForMaintenance": null,
"relId": "6.4.3.0",
"syslId": "93ac346868fc4171a514d1d0b02487e2"
}
]
|
List All Cluster Nodes: Properties
Property | UI Field Name | Description |
|---|---|---|
| Build Date | Build date for this cluster node. |
| Build Id | Build ID for this cluster node. |
| Host Name | IP address or domain/name of the host machine where the cluster node resides. |
| IP Address | IP address of this cluster node. |
| Node Id | URL of the cluster node. |
| Mode | Current mode of the cluster node. |
| Start Time | Date and time this cluster node was last started. |
| Timestamp | Date and time of the last heartbeat of this cluster node. |
| n/a |
|
| Uptime | Amount of time this cluster node has been running. |
| Paused | Indication that the Controller has been paused. |
| n/a | Deprecated. Indication that the Controller has been paused for maintenance. |
| Release | Release number for this cluster node. |
| n/a | System ID field in the database for this cluster node record. |
Read Current Cluster Node
| Description |
|---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on the current Cluster Node. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Response Example | |
Properties |