Versions Compared

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.

...


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

...

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



...


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

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

...

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


...