Provides Rolling Upgrade capabilities. ### Table of Contents - [Servers](#servers) - [Paths](#paths) - [`GET` /state](#op-get-state) - [`GET` /nodes/{nodeId}](#op-get-nodes-nodeid) - [`GET` /cluster](#op-get-cluster) - [`POST` /start](#op-post-start) - [`POST` /cancel](#op-post-cancel) - [`POST` /approve](#op-post-approve) - [Schemas](#schemas) - ClusterStateResponse - Link - NodeInfoDTO - Cluster ### Servers

URL	Description
/rest/zdu	The ZDU REST resource for the server

### Paths ### `GET` /state > Gets the Cluster State Gets the State of the Cluster and the responding Node's information. #### Responses ##### ▶ 200 - Returns full JSON representation of cluster state ###### Headers _No headers specified_ ###### application/json

Name	Type	Description	Accepted values
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
buildInfo	object	Represents a Cluster Node and its current state.	Any
buildInfo.id	string	The id of the Node in cluster.	Any
buildInfo.name	string	The name of the Node.	Any
buildInfo.ipAddress	string	The IP address of the Node.	Any
buildInfo.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
buildInfo.tasksTotal	integer	The total number of active tasks on the Node.	Any
buildInfo.activeUserCount	integer	The total number of active users on the Node.	Any
buildInfo.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
buildInfo.version	string	The version of the Node's installed Product.	Any
buildInfo.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
buildInfo.portNumber	integer		Any
buildInfo.links	array(object)	Hypermedia links	Any
buildInfo.links.rel	string	rel	Any
buildInfo.links.href	string	uri	Any

##### Example _(generated)_ ```json { "state": "STABLE", "buildInfo": { "id": "string", "name": "string", "ipAddress": "string", "state": "STARTING", "tasksTotal": 0, "activeUserCount": 0, "buildNumber": "string", "version": "string", "local": true, "portNumber": 0, "links": [ { "rel": "string", "href": "http://example.com" } ] } } ``` ##### ▶ 401 - Returned if user is not authenticated ###### Headers _No headers specified_ ##### ▶ 403 - Returned if the calling user does not have permission to view the content ###### Headers _No headers specified_ #### Tags

### `GET` /nodes/{nodeId} > Gets the Node's overview Gets the requested Node's information. #### Path parameters ##### ▷ nodeId

Name	Type	In	Description	Accepted values
nodeId (required)	string	path		Any

#### Responses ##### ▶ 200 - Returns full JSON representation of the cluster node ###### Headers _No headers specified_ ###### application/json

Name	Type	Description	Accepted values
id	string	The id of the Node in cluster.	Any
name	string	The name of the Node.	Any
ipAddress	string	The IP address of the Node.	Any
state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
tasksTotal	integer	The total number of active tasks on the Node.	Any
activeUserCount	integer	The total number of active users on the Node.	Any
buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
version	string	The version of the Node's installed Product.	Any
local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
portNumber	integer		Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

##### Example _(generated)_ ```json { "id": "string", "name": "string", "ipAddress": "string", "state": "STARTING", "tasksTotal": 0, "activeUserCount": 0, "buildNumber": "string", "version": "string", "local": true, "portNumber": 0, "links": [ { "rel": "string", "href": "http://example.com" } ] } ``` ##### ▶ 401 - Returned if user is not authenticated ###### Headers _No headers specified_ ##### ▶ 403 - Returned if the calling user does not have permission to view the content ###### Headers _No headers specified_ ##### ▶ 404 - Returned if there is no content with the given id ###### Headers _No headers specified_ #### Tags

### `GET` /cluster > Gets the Cluster overview Gets an overview of a Cluster including its current state and composition of Nodes. #### Responses ##### ▶ 200 - Returns full JSON representation of the cluster ###### Headers _No headers specified_ ###### application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.tasksTotal	integer	The total number of active tasks on the Node.	Any
nodes.activeUserCount	integer	The total number of active users on the Node.	Any
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

##### Example _(generated)_ ```json { "upgradeModeEnabled": true, "state": "STABLE", "originalVersion": "string", "nodes": [ { "id": "string", "name": "string", "ipAddress": "string", "state": "STARTING", "tasksTotal": 0, "activeUserCount": 0, "buildNumber": "string", "version": "string", "local": true, "portNumber": 0, "links": [ { "rel": "string", "href": "http://example.com" } ] } ], "links": [ { "rel": "string", "href": "http://example.com" } ] } ``` ##### ▶ 401 - Returned if user is not authenticated ###### Headers _No headers specified_ ##### ▶ 403 - Returned if the calling user does not have permission to view the content ###### Headers _No headers specified_ #### Tags

### `POST` /start > Start ZDU upgrade Enables Upgrading of individual Nodes within the Cluster, allowing a heterogeneous Cluster formation. #### Responses ##### ▶ 200 - Returns full JSON representation of the cluster ###### Headers _No headers specified_ ###### application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.tasksTotal	integer	The total number of active tasks on the Node.	Any
nodes.activeUserCount	integer	The total number of active users on the Node.	Any
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

### `POST` /cancel > Cancel ZDU upgrade Prohibits the Upgrading of individual Nodes within the Cluster. All Nodes need to be on the same version before performing this request. #### Responses ##### ▶ 200 - Returns full JSON representation of the cluster ###### Headers _No headers specified_ ###### application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.tasksTotal	integer	The total number of active tasks on the Node.	Any
nodes.activeUserCount	integer	The total number of active users on the Node.	Any
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

### `POST` /approve > Approve the ZDU upgrade Finalizes the ZDU upgrade and runs specific tasks such as cleanup scripts. #### Responses ##### ▶ 200 - Returns full JSON representation of the cluster ###### Headers _No headers specified_ ###### application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.tasksTotal	integer	The total number of active tasks on the Node.	Any
nodes.activeUserCount	integer	The total number of active users on the Node.	Any
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

### Schemas #### ClusterStateResponse

Name	Type	Description	Accepted values
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
buildInfo	object	Represents a Cluster Node and its current state.	Any
buildInfo.id	string	The id of the Node in cluster.	Any
buildInfo.name	string	The name of the Node.	Any
buildInfo.ipAddress	string	The IP address of the Node.	Any
buildInfo.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
buildInfo.tasksTotal	integer	The total number of active tasks on the Node.	Any
buildInfo.activeUserCount	integer	The total number of active users on the Node.	Any
buildInfo.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
buildInfo.version	string	The version of the Node's installed Product.	Any
buildInfo.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
buildInfo.portNumber	integer		Any
buildInfo.links	array(object)	Hypermedia links	Any
buildInfo.links.rel	string	rel	Any
buildInfo.links.href	string	uri	Any

Name	Type	Description	Accepted values
rel	string	rel	Any
href	string	uri	Any

##### Example _(generated)_ ```json { "rel": "string", "href": "http://example.com" } ``` #### NodeInfoDTO

Name	Type	Description	Accepted values
id	string	The id of the Node in cluster.	Any
name	string	The name of the Node.	Any
ipAddress	string	The IP address of the Node.	Any
state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
tasksTotal	integer	The total number of active tasks on the Node.	Any
activeUserCount	integer	The total number of active users on the Node.	Any
buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
version	string	The version of the Node's installed Product.	Any
local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
portNumber	integer		Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.tasksTotal	integer	The total number of active tasks on the Node.	Any
nodes.activeUserCount	integer	The total number of active users on the Node.	Any
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any