List node pools | NVIDIA Kubernetes Engine

{
  "nodePools": [
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "clusterID": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "gpu-workers",
      "nodeNamePrefix": "gpu",
      "kubernetesVersion": "1.29.4",
      "nodeLabels": {},
      "nodeTaints": [
        {
          "key": "nvidia.com/gpu",
          "effect": "NoSchedule",
          "value": "present"
        }
      ],
      "conditions": {
        "provisioning": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T10:00:00Z",
          "message": "Node pool provisioning completed successfully"
        },
        "provisioned": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T10:15:00Z",
          "message": "All nodes are provisioned and ready"
        },
        "deleting": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T10:15:00Z",
          "message": ""
        }
      },
      "desiredNodeCount": 4,
      "autoProvisionDisabled": false,
      "currentNodeSetID": "c2d3e4f5-1234-5678-9abc-def012345678",
      "autoModeDisabled": false,
      "provisioningMonitorDisabled": false,
      "recycleBudget": 2,
      "systemReservedMemory": "16Gi",
      "kubeReservedMemory": "2Gi",
      "machineAnnotations": {},
      "machineLabels": {},
      "description": "GPU worker node pool for AI/ML workloads",
      "maxSurge": 1,
      "nico": {
        "subnetIDs": [
          "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
        ],
        "vpcPrefixIDs": [
          "e2f3a4b5-c6d7-8901-bcde-f12345678901"
        ],
        "instanceTypeID": "b5c6d7e8-f9a0-1234-5678-90abcdef1234",
        "infinibandPartitionID": "c6d7e8f9-a0b1-2345-6789-0abcdef12345",
        "nvLinkLogicalPartitionID": "d7e8f9a0-b1c2-3456-789a-bcdef0123456",
        "sshKeyGroupIDs": [
          "e8f9a0b1-c2d3-4567-89ab-cdef01234567"
        ],
        "release": "example-ubuntu-24.04-amd64",
        "diskSelectionStrategy": "smallest"
      },
      "launchLayer": {
        "instanceType": "vm200",
        "hostOSProfile": "ubuntu-24.04-baremetal:1.2.0",
        "vmProfile": "",
        "fulfillmentStrategy": "BEST_EFFORT",
        "securityGroupRefs": {
          "primaryNetworkInterface": [
            "default-workers-sg"
          ],
          "gpuNetworkInterface": [
            "gpu-network-sg"
          ]
        }
      }
    }
  ]
}

Returns all node pools, filtered by the query parameters.

Authentication

AuthorizationBearer

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

Query parameters

clusterIDstringOptionalformat: "uuid"

Filter by cluster ID

clusterNamestringOptional

Filter by cluster name (exact match)

namestringOptional

Filter by node pool name (exact match)

Response

A list of node pools

nodePoolslist of objects

Node pools.

Errors

401

Unauthorized Error

403

Forbidden Error