Tanzu Kubernetes Cluster Resource Service Get

Tanzu Kubernetes Cluster Resource Service Get

Get a TanzuKubernetesCluster.

Request
URI
GET
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/managementclusters/{fullName.managementClusterName}/provisioners/{fullName.provisionerName}/tanzukubernetesclusters/{fullName.name}
COPY
Path Parameters
string
fullName.managementClusterName
Required

Name of the management cluster.

string
fullName.provisionerName
Required

Provisioner of the cluster.

string
fullName.name
Required

Name of this cluster.

Query Parameters
string
fullName.orgId
Optional

ID of Organization.


Responses
200

A successful response.

{
    "tanzuKubernetesCluster": {
        "type": {
            "kind": "string",
            "version": "string",
            "package": "string"
        },
        "fullName": {
            "orgId": "string",
            "managementClusterName": "string",
            "provisionerName": "string",
            "name": "string"
        },
        "meta": {
            "uid": "string",
            "generation": "string",
            "resourceVersion": "string",
            "creationTime": "string",
            "updateTime": "string",
            "description": "string",
            "parentReferences": [
                {
                    "rid": "string",
                    "uid": "string"
                }
            ]
        },
        "spec": {
            "clusterGroupName": "string",
            "tmcManaged": false,
            "tkgVsphere": {
                "settings": {
                    "network": {
                        "pods": {
                            "cidrBlocks": [
                                "string"
                            ]
                        },
                        "services": {
                            "cidrBlocks": [
                                "string"
                            ]
                        },
                        "controlPlaneEndpoint": "string",
                        "apiServerPort": 0
                    },
                    "security": {
                        "sshKey": "string"
                    }
                },
                "distribution": {
                    "version": "string",
                    "workspace": {
                        "datacenter": "string",
                        "datastore": "string",
                        "folder": "string",
                        "network": "string",
                        "resourcePool": "string"
                    },
                    "osName": "string",
                    "osVersion": "string",
                    "osArch": "string"
                },
                "topology": {
                    "controlPlane": {
                        "vmConfig": {
                            "cpu": "string",
                            "diskGib": "string",
                            "memoryMib": "string"
                        },
                        "highAvailability": false
                    },
                    "nodePools": [
                        {
                            "spec": {
                                "workerNodeCount": "string",
                                "taints": [
                                    {
                                        "effect": "string",
                                        "key": "string",
                                        "value": "string"
                                    }
                                ],
                                "tkgVsphere": {
                                    "vmConfig": {
                                        "cpu": "string",
                                        "diskGib": "string",
                                        "memoryMib": "string"
                                    }
                                },
                                "tkgServiceVsphere": {
                                    "class": "string",
                                    "storageClass": "string",
                                    "volumes": [
                                        {
                                            "name": "string",
                                            "mountPath": "string",
                                            "capacity": "number",
                                            "storageClass": "string"
                                        }
                                    ],
                                    "failureDomain": "string"
                                },
                                "tkgAws": {
                                    "instanceType": "string",
                                    "availabilityZone": "string",
                                    "subnetId": "string",
                                    "version": "string",
                                    "publicCidr": "string",
                                    "privateCidr": "string",
                                    "nodePlacement": [
                                        {
                                            "availabilityZone": "string"
                                        }
                                    ]
                                },
                                "tkgAzure": {
                                    "vmSize": "string",
                                    "availabilityZones": [
                                        "string"
                                    ]
                                }
                            },
                            "info": {
                                "name": "string",
                                "description": "string"
                            }
                        }
                    ]
                },
                "advancedConfigs": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            },
            "tkgServiceVsphere": {
                "settings": {
                    "network": {
                        "pods": {
                            "cidrBlocks": [
                                "string"
                            ]
                        },
                        "services": {
                            "cidrBlocks": [
                                "string"
                            ]
                        }
                    },
                    "storage": {
                        "classes": [
                            "string"
                        ],
                        "defaultClass": "string"
                    }
                },
                "distribution": {
                    "version": "string",
                    "osName": "string",
                    "osVersion": "string",
                    "osArch": "string"
                },
                "topology": {
                    "controlPlane": {
                        "class": "string",
                        "storageClass": "string",
                        "highAvailability": false,
                        "volumes": [
                            {
                                "name": "string",
                                "mountPath": "string",
                                "capacity": "number",
                                "storageClass": "string"
                            }
                        ]
                    },
                    "nodePools": [
                        {
                            "spec": {
                                "workerNodeCount": "string",
                                "taints": [
                                    {
                                        "effect": "string",
                                        "key": "string",
                                        "value": "string"
                                    }
                                ],
                                "tkgVsphere": {
                                    "vmConfig": {
                                        "cpu": "string",
                                        "diskGib": "string",
                                        "memoryMib": "string"
                                    }
                                },
                                "tkgServiceVsphere": {
                                    "class": "string",
                                    "storageClass": "string",
                                    "volumes": [
                                        {
                                            "name": "string",
                                            "mountPath": "string",
                                            "capacity": "number",
                                            "storageClass": "string"
                                        }
                                    ],
                                    "failureDomain": "string"
                                },
                                "tkgAws": {
                                    "instanceType": "string",
                                    "availabilityZone": "string",
                                    "subnetId": "string",
                                    "version": "string",
                                    "publicCidr": "string",
                                    "privateCidr": "string",
                                    "nodePlacement": [
                                        {
                                            "availabilityZone": "string"
                                        }
                                    ]
                                },
                                "tkgAzure": {
                                    "vmSize": "string",
                                    "availabilityZones": [
                                        "string"
                                    ]
                                }
                            },
                            "info": {
                                "name": "string",
                                "description": "string"
                            }
                        }
                    ]
                }
            },
            "tkgAzure": {
                "settings": {
                    "network": {
                        "cluster": {
                            "pods": {
                                "cidrBlocks": [
                                    "string"
                                ]
                            },
                            "services": {
                                "cidrBlocks": [
                                    "string"
                                ]
                            },
                            "apiServerPort": 0
                        },
                        "provider": {
                            "vnet": {
                                "spec": {
                                    "resourceGroup": "string",
                                    "name": "string"
                                },
                                "cidrBlock": "string"
                            },
                            "controlPlaneSubnet": {
                                "name": "string",
                                "cidrBlock": "string"
                            },
                            "workerNodeSubnet": {
                                "name": "string",
                                "cidrBlock": "string"
                            }
                        },
                        "privateCluster": {
                            "ip": "string"
                        }
                    },
                    "security": {
                        "sshKeyValue": "string",
                        "subscriptionId": "string"
                    }
                },
                "distribution": {
                    "version": "string",
                    "region": "string",
                    "resourceGroup": "string",
                    "osName": "string",
                    "osVersion": "string",
                    "osArch": "string"
                },
                "topology": {
                    "controlPlane": {
                        "vmSize": "string",
                        "availabilityZones": [
                            "string"
                        ],
                        "highAvailability": false
                    },
                    "nodePools": [
                        {
                            "spec": {
                                "workerNodeCount": "string",
                                "taints": [
                                    {
                                        "effect": "string",
                                        "key": "string",
                                        "value": "string"
                                    }
                                ],
                                "tkgVsphere": {
                                    "vmConfig": {
                                        "cpu": "string",
                                        "diskGib": "string",
                                        "memoryMib": "string"
                                    }
                                },
                                "tkgServiceVsphere": {
                                    "class": "string",
                                    "storageClass": "string",
                                    "volumes": [
                                        {
                                            "name": "string",
                                            "mountPath": "string",
                                            "capacity": "number",
                                            "storageClass": "string"
                                        }
                                    ],
                                    "failureDomain": "string"
                                },
                                "tkgAws": {
                                    "instanceType": "string",
                                    "availabilityZone": "string",
                                    "subnetId": "string",
                                    "version": "string",
                                    "publicCidr": "string",
                                    "privateCidr": "string",
                                    "nodePlacement": [
                                        {
                                            "availabilityZone": "string"
                                        }
                                    ]
                                },
                                "tkgAzure": {
                                    "vmSize": "string",
                                    "availabilityZones": [
                                        "string"
                                    ]
                                }
                            },
                            "info": {
                                "name": "string",
                                "description": "string"
                            }
                        }
                    ]
                },
                "advancedConfigs": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            },
            "tkgAws": {
                "settings": {
                    "network": {
                        "cluster": {
                            "pods": [
                                {
                                    "cidrBlocks": "string"
                                }
                            ],
                            "services": [
                                {
                                    "cidrBlocks": "string"
                                }
                            ],
                            "apiServerPort": 0
                        },
                        "provider": {
                            "vpc": {
                                "id": "string",
                                "cidrBlock": "string"
                            },
                            "subnets": [
                                {
                                    "id": "string",
                                    "cidrBlock": "string",
                                    "availabilityZone": "string",
                                    "isPublic": false
                                }
                            ]
                        }
                    },
                    "security": {
                        "sshKey": "string"
                    }
                },
                "distribution": {
                    "version": "string",
                    "region": "string",
                    "provisionerCredentialName": "string",
                    "osName": "string",
                    "osVersion": "string",
                    "osArch": "string"
                },
                "topology": {
                    "controlPlane": {
                        "instanceType": "string",
                        "availabilityZones": [
                            "string"
                        ],
                        "highAvailability": false
                    },
                    "nodePools": [
                        {
                            "spec": {
                                "workerNodeCount": "string",
                                "taints": [
                                    {
                                        "effect": "string",
                                        "key": "string",
                                        "value": "string"
                                    }
                                ],
                                "tkgVsphere": {
                                    "vmConfig": {
                                        "cpu": "string",
                                        "diskGib": "string",
                                        "memoryMib": "string"
                                    }
                                },
                                "tkgServiceVsphere": {
                                    "class": "string",
                                    "storageClass": "string",
                                    "volumes": [
                                        {
                                            "name": "string",
                                            "mountPath": "string",
                                            "capacity": "number",
                                            "storageClass": "string"
                                        }
                                    ],
                                    "failureDomain": "string"
                                },
                                "tkgAws": {
                                    "instanceType": "string",
                                    "availabilityZone": "string",
                                    "subnetId": "string",
                                    "version": "string",
                                    "publicCidr": "string",
                                    "privateCidr": "string",
                                    "nodePlacement": [
                                        {
                                            "availabilityZone": "string"
                                        }
                                    ]
                                },
                                "tkgAzure": {
                                    "vmSize": "string",
                                    "availabilityZones": [
                                        "string"
                                    ]
                                }
                            },
                            "info": {
                                "name": "string",
                                "description": "string"
                            }
                        }
                    ]
                },
                "advancedConfigs": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            },
            "topology": {
                "version": "string",
                "clusterClass": "string",
                "controlPlane": {
                    "replicas": 0,
                    "metadata": {},
                    "osImage": {
                        "name": "string",
                        "version": "string",
                        "arch": "string"
                    }
                },
                "nodePools": [
                    {
                        "spec": {
                            "class": "string",
                            "replicas": 0,
                            "failureDomain": "string",
                            "overrides": [
                                {
                                    "name": "string"
                                }
                            ],
                            "metadata": {},
                            "osImage": {
                                "name": "string",
                                "version": "string",
                                "arch": "string"
                            }
                        },
                        "info": {
                            "name": "string",
                            "description": "string"
                        }
                    }
                ],
                "variables": [
                    {
                        "name": "string"
                    }
                ],
                "network": {
                    "pods": {
                        "cidrBlocks": [
                            "string"
                        ]
                    },
                    "services": {
                        "cidrBlocks": [
                            "string"
                        ]
                    },
                    "serviceDomain": "string"
                },
                "coreAddons": [
                    {
                        "type": "string",
                        "provider": "string"
                    }
                ]
            },
            "proxyName": "string",
            "imageRegistry": "string"
        },
        "status": {
            "phase": "string"
        }
    }
}

default

An unexpected error response.

Returns grpc.gateway.runtime.Error of type(s) */*
{
    "error": "string",
    "code": 0,
    "message": "string",
    "details": [
        {
            "typeUrl": "string",
            "value": "string"
        }
    ]
}