Get a cluster | NVIDIA Kubernetes Engine

{
  "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "name": "tenant-a-prod",
  "controlPlaneKubernetesVersion": "1.29.4",
  "cniPlugin": "ovn-kubernetes",
  "cniVersion": "2.4.2",
  "etcdEncrypted": true,
  "network": {
    "podCIDR": "192.168.0.0/16",
    "serviceCIDR": "10.96.0.0/12"
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "conditions": {
    "provisioning": {
      "status": "False",
      "lastTransitionTime": "2024-01-15T10:05:42Z",
      "message": "Cluster provisioning completed successfully"
    },
    "provisioned": {
      "status": "True",
      "lastTransitionTime": "2024-01-15T10:05:42Z",
      "message": "Cluster is fully provisioned and ready"
    },
    "deleting": {
      "status": "False",
      "lastTransitionTime": "2024-01-15T09:30:00Z",
      "message": ""
    },
    "cpNodesRecycling": {
      "status": "False",
      "lastTransitionTime": "2024-01-15T10:05:42Z",
      "message": ""
    },
    "controlPlaneUpgrading": {
      "status": "False",
      "lastTransitionTime": "2024-01-15T10:05:42Z",
      "message": ""
    },
    "updateInProgress": {
      "type": "k8s_upgrade",
      "startedAt": "2024-03-20T14:00:00Z",
      "message": "Upgrading control plane from 1.28.7 to 1.29.4"
    },
    "updateFailed": {
      "status": "False",
      "lastTransitionTime": "2024-01-15T10:05:42Z",
      "message": ""
    }
  },
  "controlPlaneVIP": "10.10.0.50",
  "enableCPNodeRecycling": false,
  "controlPlaneConfig": {
    "configurationId": "c7d2e4f1-3a5b-4c8d-9e0f-1a2b3c4d5e6f",
    "desiredCount": 3,
    "maxSurge": 1,
    "provisioningMonitorDisabled": false,
    "systemReservedMemory": "16Gi",
    "machineAnnotations": {},
    "machineLabels": {},
    "nodeLabels": {},
    "nico": {
      "instanceTypePreference": [
        "d4e5f6a7-b8c9-4d0e-a1f2-b3c4d5e6f7a8"
      ],
      "subnetIDs": [
        "e5f6a7b8-c9d0-4e1f-b2a3-c4d5e6f7a8b9"
      ],
      "vpcPrefixIDs": [
        "f6a7b8c9-d0e1-4f2a-c3b4-d5e6f7a8b9c0"
      ],
      "release": "example-ubuntu-24.04-amd64",
      "diskSelectionStrategy": "smallest",
      "sshKeyGroupIDs": [
        "a7b8c9d0-e1f2-4a3b-d4c5-e6f7a8b9c0d1"
      ]
    },
    "launchLayer": {
      "instanceType": "vm200",
      "hostOSProfile": "ubuntu-24.04-baremetal:1.2.0",
      "vmProfile": "ubuntu-24.04-vm:1.0.0",
      "fulfillmentStrategy": "BEST_EFFORT",
      "securityGroupRefs": {
        "primaryNetworkInterface": [
          "cp-primary-sg"
        ],
        "gpuNetworkInterface": [
          "cp-gpu-sg"
        ]
      }
    },
    "nodeAgentConfig": {
      "version": "1.5.3"
    }
  },
  "nico": {
    "orgID": "dipfedrcvjiw",
    "siteID": "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e",
    "vpcID": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f"
  },
  "launchLayer": {
    "siteID": "us-west-2-hall-a",
    "vpcID": "vpc-d3e4f5a6-b7c8-4d9e-0f1a-2b3c4d5e6f7a",
    "orgID": "org-acme-infra",
    "vpcType": "BARE_METAL",
    "cloudProviderEnabled": false,
    "owner": {
      "userID": "usr-7f8a9b0c1d2e",
      "username": "platform-admin"
    },
    "securityGroups": [
      {
        "name": "cp-primary-sg",
        "type": "BARE_METAL",
        "networkType": "primary"
      }
    ]
  },
  "nodeAgentUpgrade": {
    "nodeId": "e4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8",
    "targetVersion": "1.5.3",
    "method": "apt",
    "phase": "Running",
    "errorMessage": "Retrying installation: connection timeout on attempt 2"
  }
}

Returns one cluster. Once provisioning finishes, conditions.provisioning is False and conditions.provisioned is True.

Authentication

AuthorizationBearer

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

Path parameters

clusterIDstringRequiredformat: "uuid"

Cluster ID.

Response

The requested cluster

idstringformat: "uuid"

Cluster ID.

namestring

Cluster name.

controlPlaneKubernetesVersionstring

Desired control-plane Kubernetes version. The running version is in ControlPlaneStatus.

cniPluginstring

CNI plugin.

cniVersionstring

CNI version.

etcdEncryptedboolean

Whether etcd is encrypted at rest.

networkobject

Pod and service network.

createdAtdatetime

Creation time.

conditionsobject

Lifecycle conditions.

controlPlaneVIPstringOptionalformat: "ipv4"

API server VIP, if configured.

enableCPNodeRecyclingbooleanOptionalDefaults to false

When true, control-plane upgrades and configuration changes replace nodes automatically. When false, nodes needing replacement are reported as pending and wait for an operator.

controlPlaneConfigobjectOptional

Current control-plane configuration.

nicoobjectOptional

NICo identifiers.

launchLayerobjectOptional

LaunchLayer identifiers.

nodeAgentUpgradeobjectOptional

The active agent upgrade and latest retry error.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error