Get a cluster's control plane | NVIDIA Kubernetes Engine

{
  "config": {
    "configurationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "desiredCount": 3,
    "maxSurge": 1,
    "provisioningMonitorDisabled": false,
    "systemReservedMemory": "16Gi",
    "machineAnnotations": {},
    "machineLabels": {},
    "nodeLabels": {},
    "nico": {
      "instanceTypePreference": [
        "c1f2a3b4-d5e6-7890-abcd-ef1234567890"
      ],
      "subnetIDs": [
        "d4e5f6a7-b8c9-4012-bcde-f01234567891"
      ],
      "vpcPrefixIDs": [
        "e5f6a7b8-c9d0-4123-cdef-012345678912"
      ],
      "release": "example-ubuntu-24.04-amd64",
      "diskSelectionStrategy": "smallest",
      "sshKeyGroupIDs": [
        "f6a7b8c9-d0e1-4234-defa-123456789023"
      ]
    },
    "launchLayer": {
      "instanceType": "vm200",
      "hostOSProfile": "ubuntu-24.04-lts",
      "vmProfile": "standard-v2",
      "fulfillmentStrategy": "BEST_EFFORT",
      "securityGroupRefs": {
        "primaryNetworkInterface": [
          "control-plane-primary-sg"
        ],
        "gpuNetworkInterface": [
          "control-plane-gpu-sg"
        ]
      }
    },
    "nodeAgentConfig": {
      "version": "1.4.2"
    }
  },
  "status": {
    "nodeCount": 3,
    "readyNodeCount": 3,
    "kubernetesVersion": "v1.30.2",
    "controlPlaneUpgrading": {
      "status": "False",
      "lastTransitionTime": "2024-06-10T08:15:00Z",
      "message": "Control plane is up to date"
    },
    "cpNodesRecycling": {
      "status": "False",
      "lastTransitionTime": "2024-06-10T08:15:00Z",
      "message": "No control-plane nodes are being recycled"
    },
    "deletingNodeCount": 0,
    "deleteRequestedNodeCount": 0,
    "rollout": {
      "managedNodeCount": 3,
      "upToDateNodeCount": 3,
      "pendingNodeCount": 0,
      "inProgressNodeCount": 0,
      "inProgress": false,
      "recyclingEnabled": true
    }
  }
}

Read-only view of the control plane: the persisted configuration plus aggregate runtime status (node counts, current Kubernetes version, rollout progress, and upgrade and recycling conditions). Change the control plane through PATCH /clusters/{clusterID}.

Authentication

AuthorizationBearer

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

Path parameters

clusterIDstringRequiredformat: "uuid"

Cluster ID.

Response

Control-plane configuration and status

configobject

The persisted control-plane configuration.

statusobject

Aggregate runtime status.

Errors

404

Not Found Error