Pools

GetPool

GET//v1/pools/{ref}

Path parameters

refstringrequired

Query parameters

cluster

Response

cluster_idstringrequired

created_atstring<date-time>required

device_classstringrequired

devices_per_nodeintegerrequired

enabledbooleanrequired

idstringrequired

labelsobjectrequired

max_nodesintegerrequired

membershipobjectrequired

min_nodesintegerrequired

namestringrequired

node_shapeobjectrequired

revisionstringrequired

taintsany[]required

updated_at

within_declared_boundsbooleanrequired

curl -X GET '//v1/pools/{ref}' \
  -H 'Accept: application/json'

{
  "cluster_id": "string",
  "created_at": "2023-01-01T00:00:00Z",
  "device_class": "string",
  "devices_per_node": 0,
  "enabled": true,
  "id": "string",
  "labels": {},
  "max_nodes": 0,
  "membership": {
    "devices_allocatable": 0,
    "devices_healthy": 0,
    "devices_total": 0,
    "nodes_cordoned": 0,
    "nodes_ready": 0,
    "nodes_total": 0
  },
  "min_nodes": 0,
  "name": "string",
  "node_shape": {},
  "revision": "string",
  "taints": [
    null
  ],
  "updated_at": null,
  "within_declared_bounds": true
}