---
title: "Lists cluster Nodes."
method: GET
path: "/cluster/enumerate"
tags: ["cluster"]
---

# Lists cluster Nodes.

`GET /cluster/enumerate`

This will return the entire cluster object and it's nodes.

## Response `200`

current cluster state

- Cluster[]
  - `FluentDConfig` FluentDConfig — DEPRECATED
    - `ip` string
    - `port` string
  - `Id` string, required — Id of the cluster.
  - `ManagementURL` string — Management url for the cluster
  - `NodeId` string — Id of the node on which this cluster object is initialized
  - `Nodes` Node[] — array of all the nodes in the cluster.
    - `Avgload` integer — Average load (percentage)
    - `Cpu` number, double — Cpu usage of the node.
    - `DataIp` string — Data IP
    - `Disks` object — List of disks on this node.
    - `GenNumber` integer — GenNumber of the node
    - `GossipPort` string — GossipPort is the port used by the gossip protocol
    - `HWType` integer
    - `Hostname` string — Hostname of this node
    - `Id` string — Id of the node.
    - `MemFree` integer — Free Memory of the node
    - `MemTotal` integer — Total Memory of the node
    - `MemUsed` integer — Used Memory of the node
    - `MgmtIp` string — Management IP
    - `NodeData` object — Node data for this node (EX: Public IP, Provider, City..)
    - `NodeLabels` object — User defined labels for node. Key Value pairs
    - `Pools` StoragePool[] — List of storage pools this node supports
      - `Cos` integer
      - `ID` integer — Deprecated! Use `uuid` instead. ID pool ID
      - `Medium` integer
      - `RaidLevel` string — RaidLevel storage raid level
      - `TotalSize` integer — TotalSize of the pool
      - `Used` integer — Used size of the pool
      - `labels` object — Labels is a list of user defined name-value pairs
      - `last_operation` StoragePoolOperation — StoragePoolOperation defines an operation being performed on a storage pool
        - `msg` string — Msg is a user friendly message for the operation
        - `params` object — Params for the parameters for the operation
        - `status` integer — OperationStatus captures the various statuses of a storage pool operation
        - `type` integer — OperationType defines the various operations that are performed on a storage pool
      - `uuid` string — UUID is the unique identifier for a storage pool
    - `SchedulerNodeName` string — SchedulerNodeName is name of the node in scheduler context. It can be empty if unable to get the name from the scheduler.
    - `SchedulerTopology` SchedulerTopology — SchedulerTopology defines the topology information of the storage node in scheduler context
      - `labels` object — Key-value pairs defining the topology of the node
    - `SecurityStatus` integer
    - `StartTime` string, date-time — Start time of this node
    - `Status` integer
    - `Timestamp` string, date-time — Timestamp
  - `Status` integer

## Changes

- **2018-02-22** `ed1f944f48d5` — 1 info
  - api tag `enumerate` removed
- **2017-12-05** `d79082f863d1` — 1 info
  - api tag `enumerate` added

[Change history](https://skmtc.dev/libopenstorage/apis/osd-api/changes/cluster/enumerate/get.md)

---

[API](https://skmtc.dev/libopenstorage/apis/osd-api.md) · [All operations](https://skmtc.dev/libopenstorage/apis/osd-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/libopenstorage/osd-api/revisions/9faa312702c4/schema)