Rate this page:

Rolling Upgrades

Provides Rolling Upgrade capabilities.

General information about using the REST APIs can be found at Using the REST API and Authenticating with the REST API.

Table of Contents

Servers

URLDescription
/rest/zduThe 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
NameTypeDescriptionAccepted 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 linksAny
buildInfo.links.rel string relAny
buildInfo.links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "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
NameTypeInDescriptionAccepted values
nodeId (required) string pathAny

Responses

▶ 200 - Returns full JSON representation of the cluster node
Headers

No headers specified

application/json
NameTypeDescriptionAccepted 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 linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "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
NameTypeDescriptionAccepted values
upgradeModeEnabled boolean If true, it's safe to upgrade the nodes of the clusterAny
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 enabledAny
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 linksAny
nodes.links.rel string relAny
nodes.links.href string uriAny
links array(object) Hypermedia linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "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
NameTypeDescriptionAccepted values
upgradeModeEnabled boolean If true, it's safe to upgrade the nodes of the clusterAny
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 enabledAny
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 linksAny
nodes.links.rel string relAny
nodes.links.href string uriAny
links array(object) Hypermedia linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "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

▶ 409 - Returned if the cluster is not in a valid state
Headers

No headers specified

Tags

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
NameTypeDescriptionAccepted values
upgradeModeEnabled boolean If true, it's safe to upgrade the nodes of the clusterAny
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 enabledAny
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 linksAny
nodes.links.rel string relAny
nodes.links.href string uriAny
links array(object) Hypermedia linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "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

▶ 409 - Returned if the cluster is not in a valid state
Headers

No headers specified

Tags

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
NameTypeDescriptionAccepted values
upgradeModeEnabled boolean If true, it's safe to upgrade the nodes of the clusterAny
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 enabledAny
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 linksAny
nodes.links.rel string relAny
nodes.links.href string uriAny
links array(object) Hypermedia linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "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

▶ 409 - Returned if the cluster is not in a valid state
Headers

No headers specified

▶ 500 - Internal Error
Headers

No headers specified

Tags

Schemas

ClusterStateResponse

NameTypeDescriptionAccepted 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 linksAny
buildInfo.links.rel string relAny
buildInfo.links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "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"
      }
    ]
  }
}
NameTypeDescriptionAccepted values
rel string relAny
href string uriAny
Example (generated)
1
2
3
4
{
  "rel": "string",
  "href": "http://example.com"
}

NodeInfoDTO

NameTypeDescriptionAccepted 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 linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "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"
    }
  ]
}

Cluster

NameTypeDescriptionAccepted values
upgradeModeEnabled boolean If true, it's safe to upgrade the nodes of the clusterAny
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 enabledAny
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 linksAny
nodes.links.rel string relAny
nodes.links.href string uriAny
links array(object) Hypermedia linksAny
links.rel string relAny
links.href string uriAny
Example (generated)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "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"
    }
  ]
}

Rate this page: