Get details Of cluster

Get details Of cluster

GET details of cluster based on the clusterId and type

Request
URI
GET
https://{api_host}/:9443/api/admin/clusters/{clusterId}
COPY
Path Parameters
uuid
clusterId
Required

clusterId

Query Parameters
clusterType
clusterType
Required

clusterType

Authentication
This operation uses the following authentication methods.
Responses
200

Status 200

Returns clusterInfo of type(s) application/json 
{
    "clusterCIDR": "100.96.0.0/11",
    "controlPlaneEndpointIP": "10.182.58.154",
    "clusterName": "tca-cluster1",
    "masterNodes": {
        "vmMemMiB": 4096,
        "vmNumCPUs": 2,
        "replicas": 3,
        "name": "tca-cluster-master-0",
        "dataStore": "nfs0-1",
        "vmDiskGiB": 40,
        "id": "11223344-5566-7788-99aa-bbccddeeff00",
        "resourcePool": "tkg-rp",
        "labels": [
            "node-role.kubernetes.io/node=",
            "node-role.kubernetes.io/node="
        ],
        "network": {
            "devices": [
                {
                    "dhcp4": true,
                    "networkName": "VM Network"
                },
                {
                    "dhcp4": true,
                    "networkName": "VM Network"
                }
            ]
        }
    },
    "workerNodes": {
        "vmMemMiB": 4096,
        "vmNumCPUs": 2,
        "replicas": 3,
        "name": "tca-cluster-master-0",
        "dataStore": "nfs0-1",
        "vmDiskGiB": 40,
        "id": "11223344-5566-7788-99aa-bbccddeeff00",
        "resourcePool": "tkg-rp",
        "labels": [
            "node-role.kubernetes.io/node=",
            "node-role.kubernetes.io/node="
        ],
        "network": {
            "devices": [
                {
                    "dhcp4": true,
                    "networkName": "VM Network"
                },
                {
                    "dhcp4": true,
                    "networkName": "VM Network"
                }
            ]
        }
    },
    "id": "11223344-5566-7788-99aa-bbccddeeff00",
    "tkgID": "11223344-5566-7788-99aa-bbccddeeff00",
    "kubernetesVersion": "v1.21.2+vmware.1",
    "serviceCIDR": "100.64.0.0/13",
    "cni": {
        "type": "antrea"
    }
}
string As uuid As uuid
tkgID
Required

A universally unique identifier (UUID) is a 128-bit label

string As uuid As uuid
id
Required

A universally unique identifier (UUID) is a 128-bit label

string
clusterName
Required

name of cluster. Note cluster name should not contains '_'

string
kubernetesVersion
Required

kubernetes version

string
serviceCIDR
Required

service CIDR

string
clusterCIDR
Required

cluster CIDR

k8nodeWithId
masterNodes
Required

masterNodes

k8nodeWithId
workerNodes
Required

workerNodes

string As ipv4 As ipv4
controlPlaneEndpointIP
Required

Endpoint IP Address accessible from outside cluster

clusterInfo_cni
cni
Required

cni


On This Page
K8S Operations
PUT
Addon API To update addon more details To cluster
POST
Create A MANAGEMENT cluster
POST
Create A WORKLOAD cluster
DELETE
Delete A cluster
DELETE
Delete kubeconfig data
GET
Get Addon details for A cluster
GET
Get details Of cluster
GET
Get kubeconfig data - A secure and standard method To enable access To your Kubernetes clusters
GET
Get kubeconfig from DB
GET
GET list Of supported namespaces and services To Be installed On TCA/TCA-CP
GET
Get status Of A cluster creation
GET
Get status Of Addon request for A cluster
GET
Get status Of service being installed Or uninstalled
GET
List all services for A given namespace In A specified cluster
GET
List clusters Of A given type either MANAGEMENT Or WORKLOAD
POST
Start An installation Of A specific service On A given namespace On TCA cluster
POST
Store kubeconfig data
POST
Store kubeconfig To DB
POST
Uninstall A specific service On A given namespace On TCA cluster