List Clusters | Ruby API Client V1 (Deprecated)
This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.
client.list_clusters()
About this method# A
List the clusters available in a multi-clusters setup for a single appID.
Examples# A
List clusters#
1
res = client.list_clusters()
Parameters# A
No parameters for this method.
Response# A
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
# |
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. |