List clusters
$client->listClusters()
We released a new version of the PHP API client in public beta. Read the beta documentation for more information.
We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.
We released a new version of the Java API client in public beta. Read the beta documentation for more information.
You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
About this method
List the clusters available in a multi-clusters setup for a single appID.
Examples
Read the Algolia CLI documentation for more information.
List clusters
1
var_dump($client->listClusters());
Parameters
This method doesn't take any parameters.
Response
This section shows the JSON response returned by the API.
Each API client encapsulates this response inside objects specific to the programming language,
so that the actual response might be different.
You can view the response by using the getLogs
method.
Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.
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
}
]
}
Field | Description |
---|---|
clusters
|
list of {cluster object}
List of clusters (of type cluster object) inside your multiCluster setup. |
clusters âž” cluster object
Field | Description |
---|---|
clusterName
|
string
Name of the cluster. |
nbRecords
|
integer
Number of records in the cluster. |
nbUserIDs
|
integer
Number of users assigned to the cluster. |
dataSize
|
integer
Data size taken by all the users assigned to the cluster. |