List Nodes of the cluster.

get

https://cluster.ip.address/v2/clusters/nodes

Privileges: CLUSTER_VIEW

Gets the list of Nodes in a cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of int64s

"List of IDs to be returned. If empty, all nodes are returned."

ids

includeMarkedForRemoval

boolean

IncludeMarkedForRemoval is used to specify whether to include nodes marked for removal.

includeOnlyUnassignedNodes

boolean

IncludeOnlyUnassignedNodes will return nodes that are not yet assigned to any cluster partition. If this parameter is specified as true and ClusterPartitionIdList is also non-empty, then no nodes will be returned.

clusterPartitionIds

array of int64s

ClusterPartitionIdList specifies the list of Ids used to filter the nodes by specified cluster partition.

clusterPartitionIds

fetchStats

boolean

FetchStats is used to specify whether to call Stats service to fetch the stats for the nodes. Stats not displayed by default

showSystemDisks

boolean

ShowSystemdisks is used to specify whether to display system disks for the nodes. Not populated by default.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError