Get Clusters
Api to get clusters for Telco Cloud Automation
Request
URI
GET
https://{api_host}/tca/caas/api/v1/orgs/{orgId}/clusters
COPY
Path Parameters
string
orgId
Optional
The identifier of the tenant
Query Parameters
string
filter
Optional
Attribute-based filtering expression. Attributes which are supported in filter expression are clusterName, clusterType, vsphereClusterName, managementClusterId, status, clusterConfig.kubernetesVersion, lastUpdated
string
fields
Optional
Attributes which should be included in the response
string
sort
Optional
Attribute based sorting expression. Same attributes as filter expression are supported for sort expression.
string
nextpage_opaque_marker
Optional
Marker to obtain the next page of a paged response. If not present, API will return first page of response with page size 10.
Header Parameters
string
x-tca-anymatch
Optional
Flag to indicate OR match is requested for filter sub-expressions. If set to true, response based on OR match is returned.
string
skip-nodes-info
Optional
Flag to skip nodes information as part of api response. If set to true, response will not have nodes information. Nodes information can be queried directly from Kubernetes cluster API instead.
Responses
200
Returns clusters
Returns Array of cluster of type(s) application/json
[
{
"id": "string",
"clusterName": "string",
"isImported": false,
"ipFamilies": "string",
"clusterType": "string",
"vsphereClusterName": "string",
"managementClusterId": "string",
"hcxUUID": "string",
"resourceProviderHcxUUID": "string",
"status": "string",
"activeTasksCount": 0,
"clusterTemplate": {
"name": "string",
"version": "string",
"id": "string"
},
"variables": [
{
"name": "string"
}
],
"clusterConfig": {
"cniEditable": false,
"csiEditable": false,
"cni": [
{
"name": "string"
}
],
"networking": [
{
"name": "string",
"properties": {
"aviController": {
"aviUsername": "string",
"aviPassword": "string",
"aviCaDataB64": "string"
},
"loadBalancerAndIngressService": {
"cloudName": "string",
"defaultServiceEngineGroup": "string",
"defaultVipNetwork": "string",
"defaultVipNetworkCidr": "string"
}
}
}
],
"csi": [
{
"name": "string",
"properties": {
"name": "string",
"isDefault": false,
"serverIP": "string",
"mountPath": "string",
"datastoreUrl": "string",
"timeout": "string",
"region": "string",
"zone": "string"
}
}
],
"kubernetesVersion": "string",
"tools": [
{}
],
"systemSettings": [
{
"name": "string",
"properties": {
"host": "string",
"port": 0,
"protocol": "string"
}
}
]
},
"airgapConfig": {
"type": "string",
"extensionId": "string",
"fqdn": "string",
"ip": "string",
"caCert": "string"
},
"proxyConfig": {
"type": "string",
"extensionId": "string",
"httpProxy": "string",
"httpsProxy": "string",
"noProxy": "string",
"caCert": "string"
},
"clusterId": "string",
"clusterUrl": "string",
"kubeConfig": "string",
"endpointIP": "string",
"masterNodes": [
{
"cpu": 0,
"memory": 0,
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"isManagement": false,
"nameservers": [
"string"
]
}
],
"nodes": [
{
"ip": "string",
"vmName": "string"
}
],
"storage": 0,
"replica": 0,
"labels": [
"string"
],
"cloneMode": "string"
}
],
"workerNodes": [
{
"cpu": 0,
"memory": 0,
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"isManagement": false,
"nameservers": [
"string"
]
}
],
"nodes": [
{
"ip": "string",
"vmName": "string"
}
],
"storage": 0,
"replica": 0,
"labels": [
"string"
],
"cloneMode": "string",
"config": {
"cpuManagerPolicy": {
"type": "string",
"policy": "string",
"properties": {
"kubeReserved": {
"cpu": 0,
"memoryInGiB": 0
},
"systemReserved": {
"cpu": 0,
"memoryInGiB": 0
}
}
},
"healthCheck": {
"nodeStartupTimeout": "string",
"unhealthyConditions": [
{
"type": "string",
"status": "string",
"timeout": "string"
}
]
}
}
}
],
"vimId": "string",
"error": "string",
"hasSupportedKubernetesVersion": false,
"supportedOperatorsVersion": "string",
"clusterPassword": "string",
"creationTenantId": "string",
"creationUser": "string",
"lastUpdated": "string",
"creationDate": "string",
"placementParams": [
{
"name": "string",
"type": "string"
}
],
"warnings": [
{
"operationType": "string",
"message": "string",
"errorCode": "string",
"internalMessage": "string"
}
],
"errors": [
{
"operationType": "string",
"message": "string",
"errorCode": "string",
"internalMessage": "string"
}
]
}
]
On This Page
Infra Operations
POST
Abort Cluster Operation
POST
Add Repo Details
PUT
Change Cluster Password
POST
Create Cluster Node Pool
DELETE
Delete Node Pool
POST
Deploy Cluster
PUT
Edit Cluster
PUT
Edit Cluster Config
PUT
Edit Node Pool
POST
Genereate Spec
GET
Get Cluster Config
GET
Get Clusters
GET
Get Clusters Node Pools
GET
Get K8 Cluster Node Pool
GET
Get Node Pool Customization
GET
Get Repo Details
POST
Kuberenetes Version Upgrade Matrix
PUT
Pause Node Pool
DELETE
Remove Repo Details
POST
Retry Cluster Operation
GET
Supported Kubernetes Versions
PUT
Sync Esx Info
PUT
Transform Cluster
PUT
Unpause Node Pool
PUT
Update Repo Details
PUT
Upgrade Cluster
PUT
Upgrade Cluster Addon
GET
Upgrade History
GET
Validate Upgrade Cluster
GET
Vsphere Csi Zone Support