List Clusters | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

client.listClusters(callback)

About this method

List the clusters available in a multi-clusters setup for a single appID.

Examples

List clusters

1
var_dump($client->listClusters());

1
res = client.list_clusters()

1
2
3
4
5
client.listClusters((err, content) => {
  if (err) throw err;

  console.log(content);
});

1
res = client.list_clusters();

1
2
3
4
var res = client.ListClusters();

// Asynchronous
var res = await client.ListClustersAsync();

1
2
3
4
ListClustersResponse resp = client.listClusters();

// Asynchronous
CompletableFuture<ListClustersResponse> resp = client.listClustersAsync();

1
res, err := client.ListClusters()

1
2
3
client.execute {
  list clusters
}

$
$
$
$
curl -X GET \
     -H "X-Algolia-API-Key: ${API_KEY}" \
     -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
    "https://${APPLICATION_ID}.algolia.net/1/clusters"

1
client.listClusters()

Parameters

No parameters for this method.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "clusters": [
    {
      "clusterName": "c10-test",
      "nbRecords": 139,
      "nbUserIDs": 19,
      "dataSize": 23544
    },
    {
      "clusterName": "c11-test",
      "nbRecords": 223,
      "nbUserIDs": 7,
      "dataSize": 40311
    }
  ]
}

clusters ➔ cluster object