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

# 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.
  - `LoggingURL` string — Logging url for 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
    - `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 — 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
    - `StartTime` string, date-time — Start time of this node
    - `Status` integer
    - `Timestamp` string, date-time — Timestamp
  - `Status` integer
  - `TunnelConfig` TunnelConfig — TunnelConfig describes key, cert and endpoint of a reverse proxy tunnel DEPRECATED
    - `cert` string
    - `key` string
    - `tunnel_endpoint` string

## Changes

- **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/d79082f863d1/schema)