List nodes | NVIDIA Kubernetes Engine

{
  "nodes": [
    {
      "id": "a3f1c2d4-5e6b-7890-abcd-ef1234567890",
      "nodePoolID": "00000000-0000-0000-0000-000000000000",
      "nodeSetID": "00000000-0000-0000-0000-000000000000",
      "name": "tenant-a-prod-w-0001",
      "controlPlane": true,
      "conditions": {
        "pending": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:00:00Z",
          "message": "Node is no longer pending"
        },
        "provisioningClaimed": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:01:30Z",
          "message": "Provisioning operation claimed by controller"
        },
        "provisioning": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:12:45Z",
          "message": "Provisioning completed successfully"
        },
        "readyToJoin": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:13:00Z",
          "message": "Node passed pre-join checks"
        },
        "joined": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:14:22Z",
          "message": "Node successfully joined the cluster"
        },
        "provisioned": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": "Node is fully provisioned"
        },
        "deleting": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "kubernetesReady": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:16:10Z",
          "message": "kubelet reports node Ready"
        },
        "kubernetesUnschedulable": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:16:10Z",
          "message": ""
        },
        "nodeAgentReady": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:16:30Z",
          "message": "NVKE node agent is healthy"
        },
        "rebooting": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "markedForRecycling": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "markedForRepair": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "deleteRequested": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "controlPlaneRolloutRequired": {
          "status": "True",
          "lastTransitionTime": "2024-03-20T14:00:00Z",
          "message": "Node differs from desired configuration: kubernetesVersion changed"
        }
      },
      "ip": "10.0.1.42",
      "nico": {
        "instanceID": "nico-inst-7f3a2b1c",
        "machineID": "nico-mach-4d8e9f0a",
        "instanceTypeID": "b2e4f6a8-1c3d-4e5f-9a0b-7c8d9e0f1a2b"
      },
      "launchLayer": {
        "instanceID": "ll-inst-9c2d4e6f",
        "machineID": "ll-mach-1a3b5c7d",
        "rackID": "rack-us-east-1a-07"
      },
      "controlPlaneRollout": {
        "pending": true,
        "actionable": true,
        "changes": [
          {
            "field": "kubernetesVersion",
            "from": "1.29.2",
            "to": "1.30.1"
          }
        ],
        "pinnedConfigurationID": "c1d2e3f4-a5b6-7890-cdef-012345678901",
        "desiredConfigurationID": "d4e5f6a7-b8c9-0123-def0-123456789abc"
      }
    }
  ]
}

Returns all nodes, filtered by the query parameters. All filters are exact match.

Authentication

AuthorizationBearer

A JWT from an issuer the Operator has configured, carried as Authorization: Bearer <token>.

Query parameters

clusterIDstringOptionalformat: "uuid"

Filter by cluster ID

nodePoolIDstringOptionalformat: "uuid"

Filter by node pool ID

clusterNamestringOptional

Filter by cluster name (exact match)

namestringOptional

Filter by node name (exact match)

controlPlanebooleanOptional

true returns only control-plane nodes; false only workers

Response

A list of nodes

nodeslist of objects

Nodes.

Errors

401

Unauthorized Error

403

Forbidden Error