Infra Cluster Query
Api to query Kubernetes Cluster for Telco Cloud Automation
query cluster
{
"filter": {
"clusterType": "string",
"status": "string"
}
}Query cluster response.
{
"placementParams": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"creationUser": "creationUser",
"isImported": true,
"activeTasksCount": 0,
"_links": "{}",
"supportedOperatorsVersion": "supportedOperatorsVersion",
"clusterUrl": "clusterUrl",
"workerNodes": [
{
"cloneMode": "fullClone",
"memory": 2048,
"nodes": [
{
"vmName": "vmName",
"ip": "ip"
},
{
"vmName": "vmName",
"ip": "ip"
}
],
"replica": 1,
"name": "name",
"cpu": 1,
"storage": 20,
"networks": [
{
"nameservers": [
"nameservers",
"nameservers"
],
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2
},
{
"nameservers": [
"nameservers",
"nameservers"
],
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2
}
],
"config": {
"healthCheck": {
"unhealthyConditions": [
{
"type": "Ready",
"timeout": "timeout",
"status": true
},
{
"type": "Ready",
"timeout": "timeout",
"status": true
}
],
"nodeStartupTimeout": "nodeStartupTimeout"
},
"cpuManagerPolicy": {
"type": "kubernetes",
"properties": {
"systemReserved": {
"memoryInGiB": 1,
"cpu": 1
},
"kubeReserved": {
"memoryInGiB": 1,
"cpu": 1
}
},
"policy": "static"
}
},
"labels": [
"labels",
"labels"
]
},
{
"cloneMode": "fullClone",
"memory": 2048,
"nodes": [
{
"vmName": "vmName",
"ip": "ip"
},
{
"vmName": "vmName",
"ip": "ip"
}
],
"replica": 1,
"name": "name",
"cpu": 1,
"storage": 20,
"networks": [
{
"nameservers": [
"nameservers",
"nameservers"
],
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2
},
{
"nameservers": [
"nameservers",
"nameservers"
],
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2
}
],
"config": {
"healthCheck": {
"unhealthyConditions": [
{
"type": "Ready",
"timeout": "timeout",
"status": true
},
{
"type": "Ready",
"timeout": "timeout",
"status": true
}
],
"nodeStartupTimeout": "nodeStartupTimeout"
},
"cpuManagerPolicy": {
"type": "kubernetes",
"properties": {
"systemReserved": {
"memoryInGiB": 1,
"cpu": 1
},
"kubeReserved": {
"memoryInGiB": 1,
"cpu": 1
}
},
"policy": "static"
}
},
"labels": [
"labels",
"labels"
]
}
],
"endpointIP": "endpointIP",
"managementClusterId": "managementClusterId",
"clusterId": "clusterId",
"error": "error",
"hasSupportedKubernetesVersion": true,
"lastUpdated": "lastUpdated",
"clusterName": "clusterName",
"clusterTemplate": {
"name": "name",
"id": "id",
"version": "version"
},
"id": "id",
"clusterType": "clusterType",
"hcxUUID": "hcxUUID",
"proxyConfig": {
"http_proxy": "http_proxy",
"no_proxy": "no_proxy",
"https_proxy": "https_proxy",
"caCert": "caCert",
"type": "extension",
"extensionId": "extensionId"
},
"airgapConfig": {
"caCert": "caCert",
"fqdn": "fqdn",
"ip": "ip",
"type": "extension",
"extensionId": "extensionId"
},
"vimId": "vimId",
"clusterPassword": "clusterPassword",
"warnings": [
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
},
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
}
],
"kubeConfig": "kubeConfig",
"creationDate": "creationDate",
"vsphereClusterName": "vsphereClusterName",
"clusterConfig": {
"csiEditable": true,
"systemSettings": [
{
"name": "syslog",
"properties": {
"protocol": "udp",
"port": 0,
"host": "host"
}
},
{
"name": "syslog",
"properties": {
"protocol": "udp",
"port": 0,
"host": "host"
}
}
],
"csi": [
{
"name": "vsphere-csi",
"properties": {
"isDefault": true,
"mountPath": "mountPath",
"datastoreUrl": "datastoreUrl",
"zone": "zone",
"name": "name",
"serverIP": "serverIP",
"region": "region",
"timeout": "timeout"
}
},
{
"name": "vsphere-csi",
"properties": {
"isDefault": true,
"mountPath": "mountPath",
"datastoreUrl": "datastoreUrl",
"zone": "zone",
"name": "name",
"serverIP": "serverIP",
"region": "region",
"timeout": "timeout"
}
}
],
"cniEditable": true,
"tools": [
{
"name": "helm",
"version": "version",
"properties": "{}"
},
{
"name": "helm",
"version": "version",
"properties": "{}"
}
],
"cni": [
{
"name": "calico",
"properties": "{}"
},
{
"name": "calico",
"properties": "{}"
}
],
"kubernetesVersion": "kubernetesVersion"
},
"masterNodes": [
{
"cloneMode": "fullClone",
"memory": 2048,
"nodes": [
{
"vmName": "vmName",
"ip": "ip"
},
{
"vmName": "vmName",
"ip": "ip"
}
],
"replica": 1,
"name": "name",
"cpu": 1,
"storage": 20,
"networks": [
{
"nameservers": [
"nameservers",
"nameservers"
],
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 5
},
{
"nameservers": [
"nameservers",
"nameservers"
],
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 5
}
],
"labels": [
"labels",
"labels"
]
}
],
"errors": [
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
},
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
}
],
"status": "status"
}id
clusterName
Flag to indicate if this cluster is imported. Clusters created outside TCA and imported to TCA will have this flag set to True.
Type of cluster. Can be Workload/Management.
Name of the vsphere cluster on which the k8s cluster is deployed.
Id of the management cluster, only relevant for workload clusters.
Endpoint id of the tca cp on which the cluster is deployed.
Current status of the cluster.
Number of operations in processing or queued state on the cluster
clusterId
clusterUrl
kubeConfig
API server load balancer IP. This address is used by Kube-vip pod that runs in the control plane nodes and provides load balancing services for the cluster API server. Make sure that this Ip Address is not in the DHCP range,but its in the same subnet as the DHCP range of master node's management network.
Pool of nodes on which Kubernetes control plane can run.
Pool of worker nodes on which Network Functions can run. Each Node Pool can be deployed on a vSphere Resource Pool. All the worker nodes in a node pool contain same Kubelet and Operating System Configuration. It is recommended that a Node Pool should be used by only one Network Function Instance, if it has Infrastructure requirements.
vimId
Any error associated with the cluster. For eg. "Kubernetes version not supported".
Flag to indicate if the cluster is on one of the supported kubernetes versions.
The supported version for the operators like vmconfig operator and nodeconfig operator.
This password is used to login to the master nodes and worker nodes. The username is "capv".
_links
creationUser
lastUpdated
creationDate
Errors are for internal use and subject to change. Please use task for monitoring progress of operation.
Bad Request
{
"errors": [
{
"code": "code",
"message": "message"
}
]
}Internal Server Error
{
"errors": [
{
"code": "code",
"message": "message"
}
]
}