Versions Compared

Old Version 1

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Anchor
List All Cluster Nodes
List All Cluster Nodes

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.

Anchor
List All Cluster Nodes XML and JSON Examples
List All Cluster Nodes XML and JSON Examples

List All Cluster Nodes: XML and JSON Examples

XML

JSON


Expand
titleXML


<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>




Expand
titleJSON


[ {
  "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"
  }
]



Anchor
List All Cluster Nodes Properties
List All Cluster Nodes Properties

List All Cluster Nodes: Properties

Property

UI Field Name

Description

Anchor
buildDate - LACN
buildDate - LACN
buildDate

Build Date

Build date for this cluster node.

Anchor
buildId - LACN
buildId - LACN
buildId

Build Id

Build ID for this cluster node.

Anchor
hostName - LACN
hostName - LACN
hostName

Host Name

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

Anchor
ipAddress - LACN
ipAddress - LACN
ipAddress

IP Address

IP address of this cluster node.

Anchor
nodeId - LACN
nodeId - LACN
nodeId

Node Id

URL of the cluster node.

Anchor
nodeMode - LACN
nodeMode - LACN
nodeMode

Mode

Current mode of the cluster node.

Anchor
nodeStart - LACN
nodeStart - LACN
nodeStart

Start Time

Date and time this cluster node was last started.

Anchor
nodeTs - LACN
nodeTs - LACN
nodeTs

Timestamp

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

Anchor
nodeUptime - LACN
nodeUptime - LACN
nodeUptime

n/a

nodeUptimeDisplay (in seconds).

Anchor
nodeUptimeDisplay - LACN
nodeUptimeDisplay - LACN
nodeUptimeDisplay

Uptime

Amount of time this cluster node has been running.

Anchor
paused - LACN
paused - LACN
paused

Paused

Indication that the Controller has been paused.

Anchor
pausedForMaintenance - LACN
pausedForMaintenance - LACN
pausedForMaintenance

n/a

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

Anchor
relId - LACN
relId - LACN
relId

Release

Release number for this cluster node.

Anchor
sysId - LACN
sysId - LACN
sysId

n/a

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

Anchor
Read Current Cluster Node
Read Current 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.

Anchor
Read Current Cluster Node XML and JSON Examples
Read Current Cluster Node XML and JSON Examples

Read Current Cluster Node: XML and JSON Examples

XML

JSON


Expand
titleXML


<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>2016-01-20 09:54:20</nodeTs>
      <nodeUptime>55150</nodeUptime>
      <nodeUptimeDisplay>15 Hours 19 Minutes 10 Seconds</nodeUptimeDisplay>
      <paused>false</paused>
      <pausedForMaintenance />
      <relId>6.4.3.0</relId>
      <syslId>3a5385a3f6df47cb8eb7a2e29845d55b</syslId>
</clusterNode>




Expand
titleJSON


{
  "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 19 Minutes 10 Seconds",
  "paused": false,
  "pausedForMaintenance": null,
  "relId": "6.4.3.0",
  "syslId": "93ac346868fc4171a514d1d0b02487e1"
}


...