Infra Cluster Query
Api to query Kubernetes Cluster for Telco Cloud Automation
Request
URI
POST
https://{api_host}/tca/caas/api/v1/orgs/{orgId}/clusters/query
COPY
Path Parameters
string
orgId
Optional
The identifier of the tenant
Request Body
query cluster
{
"filter": {
"clusterType": "string",
"status": "string"
}
}object
filter
Optional
filter
Responses
200
Query cluster response.
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"
}
]
}
]
400
Returns BadRequest of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}