API Reference / API Methods / MultiClusters / List clusters
Feb. 26, 2019

List Clusters

Required API Key: Admin
Method signature 
$client->listClusters()
See code examples

About this method #

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

Examples #

List clusters#

Edit
Copy 
1

var_dump($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#

Copy
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?

PHP