Create a Cluster

Create a Solr cluster in Lucidworks Managed Search.

Note
This topic describes how to create a cluster in Managed Search using the API. For instructions using the UI, see Manage Clusters in Managed Search UI.

Request

Send an HTTP request with these elements.

Element Description

Method

POST

Endpoint

customers/customerId/clusters

Request header fields

Request header fields specify metadata for the request. For example, the Authorization header contains the OAuth2 access token.

Message body

JSON object that specifies attributes needed when creating a cluster

Attributes for creating a Solr cluster

These attributes are required when creating a Solr cluster.

Attribute Type Required? Description

autoscaling

JSON object

no

JSON object that indicates whether to enable autoscaling, as well as autoscaling properties

id

string

yes

Meaningful, unique name for the Solr cluster. You can’t change the name of a cluster after it is created.

nodeCount

integer

yes

Number of Solr nodes

nodeType

string

yes

Type of all Solr nodes

storageSizeGB

integer

yes

Storage size in gigabytes to allocate for the Solr cluster

description

string

no

Description of the cluster

maintenanceTimeFrame

string

no

Timeframe for routine cluster maintenance

Response

A response from a request to create a Solr cluster contains these elements.

Element Description

Status line

The status line contains the status code and the reason phrase.

Response header fields

Response header fields specify metadata about the response.

Message body

JSON object that specifies the taskId of the task that will create the cluster and the status of the API request.

Example

Request:

curl "https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/lucidworks/clusters" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer accessTokenManagedSearch" -d '{ "id": "jeff-1", "nodeCount": 2, "nodeType": "standard.small", "storageSizeGB": 20, "description": "test cluster", "maintenanceWindow": "SUNDAY,21:45"}'

The POST method is implicit.

Response:

Element Example

Status line

HTTP/1.1 202 Accepted

Response header fields

Response header fields specify metadata about the response.

Message body

{"taskId":"89","status":"submitted"}