Sign in

v1

latestOpenAPI 3.0.02026-07-1774355.5 KB

Get information about nodes

get/v0.7.0/nodes

Query parameters

namestring

Filter nodes by name

infrastructurestring

Filter nodes by infrastructure

tagsstring[]

Filter nodes by tag

{"stackTrail":"paths:/v0.7.0/nodes:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Get list of object names instead of full objects

{"stackTrail":"paths:/v0.7.0/nodes:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Fold expandable objects

{"stackTrail":"paths:/v0.7.0/nodes:get:parameters:5:schema","oasType":"schema","type":"unknown"}

Report object types in YAML dumps

format'yaml' | 'json'

Select output format

Response

successful operation

namestring

The names of the nodes in this set.

rackstring

The names of the racks in this set.

slotinteger

The slot in the rack used by the first node in this set.

tagsstring[]

The list of tags associated to these nodes.

typestring

Unique identifier of node type.

Example response

[
  {
    "infrastructure": {
      "description": "HPC cluster",
      "layout": [
        {
          "misc": [],
          "network": [],
          "nodes": [],
          "rack": "A[01-10]",
          "storage": [],
          "tags": [
            "compute"
          ]
        }
      ],
      "name": "mercury",
      "tags": [
        "hpc"
      ]
    },
    "name": "cn[001-0040]",
    "rack": "A[01-10]",
    "slot": 10,
    "tags": [
      "compute",
      "standard"
    ],
    "type": "server"
  }
]