Clusters API

Use the Clusters API to manage your Solr clusters in Lucidworks Managed Search:

  • Create Solr clusters in Lucidworks Managed Search.

  • Using the PUT method, modify one or more attributes of a Solr cluster

  • Using the PATCH method, modify one or more attributes of a Solr cluster

  • List all of your organization’s Solr clusters.

  • Get detailed information about a specific Solr cluster.

  • Delete a Solr cluster.

Create a Solr cluster

Create a Solr cluster in Lucidworks Managed Search.

Request

Send an HTTP request with these elements.

Element Description

Method

POST

Request URI

https://cloud.lucidworks.com/managed/api/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

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 -XPOST "\https://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"}'

Response:

Element Example

Status line

HTTP/1.1 202 Accepted

Response header fields

content-type: application/json;charset=utf-8 (and others)

Message body

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

List Solr clusters

List all Solr clusters for your organization in Lucidworks Managed Search.

Request

Send an HTTP request with these elements.

Element Description

Method

GET

Request URI

https://cloud.lucidworks.com/managed/api/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

None

Response

A response from a request to list all Solr clusters for your organization 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 lists all Solr clusters for your organization and the collections that they contain.

Example

Request:

curl -XGET "https://cloud.lucidworks.com/managed/api/customers/lucidworks/clusters" -H "accept: application/json" -H "Authorization: Bearer accessTokenManagedSearch"

Response:

Element Example

Status line

HTTP/1.1 200 OK

Response header fields

content-type: application/json;charset=utf-8 (and others)

Message body

See immediately below.

Message body:

[
  {
    "id": "josh-1",
    "nodeCount": 3,
    "nodeType": "standard.small",
    "storageSizeGB": 20,
    "description": "test cluster",
    "maintenanceTimeFrame": "SUNDAY,00:00",
    "autoscaling": {
      "enabled": false,
      "minNodes": 0,
      "maxNodes": 0,
      "targetSearchRate": 0
    },
    "customerId": "acmecorp",
    "address": "\https://cloud.lucidworks.com/acmecorp/josh-1/solr/",
    "status": "ready",
    "createdTime": "2019-06-10 20:37:31"
  },
  {
    "id": "jeff-1",
    "nodeCount": 2,
    "nodeType": "standard.small",
    "storageSizeGB": 20,
    "description": "test cluster",
    "maintenanceTimeFrame": "SUNDAY,00:00",
    "version": "8.1.1",
    "autoscaling": {
      "enabled": false,
      "minNodes": 0,
      "maxNodes": 0,
      "targetSearchRate": 0
    },
    "customerId": "acmecorp",
    "address": "\https://cloud.lucidworks.com/acmecorp/jeff-1/solr/",
    "status": "ready",
    "createdTime": "2019-07-17 18:36:22"
  }
]

Get detailed information about a specific Solr cluster

Get detailed information about a Solr cluster for your organization in Lucidworks Managed Search.

Request

Send an HTTP request with these elements.

Element Description

Method

GET

Request URI

https://cloud.lucidworks.com/managed/api/customers/customerId/clusters/clusterId

Request header fields

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

Message body

None

Response

A response from a request to get detailed information about 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 contains information about the Solr cluster.

Modify attributes of a Solr cluster using PUT

Use the PUT method to modify one or more attributes of a Solr cluster in Managed Search. The operation is atomic; either all attributes are updated or none of them are (if the operation fails).

Request

Send an HTTP request with these elements.

Element Description

Method

PUT

Request URI

https://cloud.lucidworks.com/managed/api/customers/customerId/clusters/clusterId

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 the cluster attributes that you want to modify, as well as all other cluster attributes (the attributes that aren’t changing).

Cluster attributes

You can modify these attributes of a Solr cluster after its creation.

Attribute Type Required? Description

autoscaling

object

no

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

nodeCount

integer

no

Number of Solr nodes

nodeType

string

no

Type of each Solr node

storageSizeGB

integer

no

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

All attributes are optional. The command must specify one or more attributes.

Response

A response from a request to modify multiple attributes of 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 modified values of the cluster attributes.

Example

Request:

curl -XPUT "https://cloud.lucidworks.com/managed/api/customers/lucidworks/clusters/jeff-1" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer accessTokenManagedSearch" -d '{"nodeCount": 4, "nodeType": "standard.large", "storageSizeGB": 50, "description": "a changed temporary cluster", "maintenanceWindow": "SUNDAY,07:30:00"}'

Modify attributes of a Managed Search cluster using PATCH

Using the PATCH method, modify one or more attributes of a Solr cluster atomically, from a subset of attributes that can be modified.

Request

Send an HTTP request with these elements.

Element Description

Method

PATCH

Request URI

https://cloud.lucidworks.com/managed/api/customers/customerId/clusters/clusterId

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 the cluster attribute to modify

Cluster attributes

Response

A response from a request to modify multiple attributes of 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 modified values of the cluster attributes.

Delete a Solr cluster

Request

Send an HTTP request with these elements.

Element Description

Method

DELETE

Request URI

https://cloud.lucidworks.com/managed/api/customers/customerId/clusters/clusterId

Request header fields

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

Message body

None

Response

A response from a request to modify multiple attributes of 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 modified values of the cluster attributes.

Example

Request:

curl -XDELETE "https://cloud.lucidworks.com/managed/api/customers/lucidworks/clusters/jeff-1" -H "Authorization: Bearer accessTokenManagedSearch"