Create Cluster

URL:
https://<clusters-url>/create
Methods:
POST
Required Capability:
Administrator
Version Introduced:
10.1

Description

This operation creates a new cluster within your site. Creating a new cluster involves defining a clustering protocol that will be shared by all server machines participating in the cluster. All server machines that are added to the cluster must be registered with the site. The clustering protocol and the initial list of server machines are optional. In this case, the server picks the default clustering protocol and selects the port numbers such that they do not conflict with other configured ports on the server machine. Once a cluster has been created you can add more machines (to increase the compute power) or remove them (to reduce the compute power) dynamically.

Request parameters

ParameterDetails

clusterName

The name of the cluster. This must be a unique name within a site.

Example

Use dark colors for code blocksCopy
1
clusterName=MapsCluster

machineNames

An optional comma-separated list of server machines to be added to this cluster.

Example

Use dark colors for code blocksCopy
1
tcpClusterPort=5000

tcpClusterPort

A TCP port number that will be used by all the server machines to communicate with each other when using the TCP clustering protocol. This is the default clustering protocol. If this parameter is missing, a suitable default will be used.

Use dark colors for code blocksCopy
1
machineNames=SERVER1.DOMAIN.COM,SERVER2.DOMAIN.COM

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Below is a sample POST request for create :

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/clusters/create HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

clusterName=MapsCluster&tcpClusterPort=5000&machineNames=SERVER1.DOMAIN.COM,SERVER2.DOMAIN.COM&f=json

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.