API Reference / API Methods / MultiClusters / List clusters
Required API Key: Admin
Method signature
$client->listClusters()

About this method

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.

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

Examples

List clusters

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

Parameters

No parameters for this method.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

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
list of {cluster object}

List of clusters (of type cluster object) inside your multiCluster setup.

clusters ➔ cluster object

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.

Did you find this page helpful?