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://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 |
|
Properties |
List All Cluster Nodes: XML and JSON Examples
XML |
JSON |
---|---|
|
|
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 |
http://localhost:8080/uc/resources/clusternode/info |
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
Response Example |
|
Properties |
Read Current Cluster Node: XML and JSON Examples
XML |
JSON |
---|---|
|
|