Get nodepools

GET

http://localhost:8080/api/v1/node-pools

GET

/api/v1/node-pools

curl http://localhost:8080/api/v1/node-pools \
     -H "Authorization: Bearer <token>"

{
  "nodepools": [
    {
      "name": "v100",
      "labelKey": "node-type",
      "labelValue": "type-x",
      "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
      "id": "5",
      "tenantId": 1,
      "clusterName": "prod-cluster",
      "createdBy": "user@lab.com",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedBy": "user@lab.com",
      "updatedAt": "2024-01-15T09:30:00Z",
      "isDefault": false,
      "gpuNetworkAccelerationLabelKey": "string",
      "gpuNetworkAccelerationDetection": "Auto",
      "networkTopologyName": "default-topology",
      "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
      "schedulingConfiguration": {
        "gpuPodsPlacementStrategy": {
          "node": "spread",
          "device": "spread"
        },
        "cpuPodsPlacementStrategy": {
          "node": "spread"
        },
        "minGuaranteedRuntime": "5d8h40m",
        "timeBasedFairShare": {
          "enabled": true,
          "historicalUsageWeight": 1.5,
          "decayHalfLife": "24h",
          "windowType": "tumbling",
          "windowDuration": "2d",
          "tumblingWindowStartTime": "2025-01-06T08:00:00Z"
        },
        "numaAwareScheduling": true,
        "placementStrategy": {
          "cpu": "spread",
          "gpu": "spread"
        }
      },
      "phase": "Creating",
      "phaseMessage": "all nodes are down",
      "status": {
        "labelKey": "node-type",
        "labelValue": "type-x",
        "gpuNetworkAccelerationLabelKey": "string",
        "gpuNetworkAccelerationDetection": "Auto",
        "gpuResourceOptimization": {
          "swapEnabled": true,
          "cpuSwapMemorySize": "10000M",
          "reservedGpuMemoryForSwapOperations": "10G",
          "nodeLevelSchedulerEnabled": true
        },
        "schedulingConfiguration": {
          "gpuPodsPlacementStrategy": {
            "node": "spread",
            "device": "spread"
          },
          "cpuPodsPlacementStrategy": {
            "node": "spread"
          },
          "minGuaranteedRuntime": "5d8h40m",
          "timeBasedFairShare": {
            "enabled": true,
            "historicalUsageWeight": 1.5,
            "decayHalfLife": "24h",
            "windowType": "tumbling",
            "windowDuration": "2d",
            "tumblingWindowStartTime": "2025-01-06T08:00:00Z"
          },
          "numaAwareScheduling": true,
          "placementStrategy": {
            "cpu": "spread",
            "gpu": "spread"
          }
        },
        "conditions": [
          {
            "type": "string",
            "reason": "TopologyMismatch",
            "message": "Network Topology labels mismatch",
            "status": "True",
            "nodes": [
              "node1",
              "node2"
            ]
          }
        ],
        "gpuNetworkAccelerationDetected": true,
        "nodes": [
          "node1"
        ],
        "placementStrategy": {
          "cpu": "spread",
          "gpu": "spread"
        },
        "overProvisioningRatio": 1
      },
      "deletedBy": "user@lab.com",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Get nodepools

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

sortByenumOptional

Sort results by a parameters.

sortOrderenumOptionalDefaults to asc

Sort results in descending or ascending order.

Allowed values:

offsetintegerOptional

The offset of the first item returned in the collection.

limitintegerOptional1-500Defaults to 50

The maximum number of entries to return.

Response

nodepoolslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error