List All Collections

List all collections in a Solr cluster in Lucidworks Managed Search.

Request

Send an HTTP request with these elements.

Element Description

Method

GET

Endpoint

customers/customerId/clusters/clusterId/collections

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 collections in 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 lists all collections in the specified Solr cluster.

Example

Request:

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

The GET method is implicit.

Response:

Element Example

Status line

HTTP/1.1 200 OK

Response header fields

Response header fields specify metadata about the response.

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://pg01.us-west1.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://pg01.us-west1.cloud.lucidworks.com/acmecorp/jeff-1/solr/",
    "status": "ready",
    "createdTime": "2019-07-17 18:36:22"
  }
]