Infra Cluster Query

Infra Cluster Query

Api to query Kubernetes Cluster for Telco Cloud Automation

Request
URI
POST
https://{api_host}/hybridity/api//infra/k8s/clusters/query
COPY
Request Body

query cluster

body of type(s) application/json
Required 
{
    "filter": {
        "clusterType": "string",
        "status": "string"
    }
}
infrak8sclustersquery_filter
filter
Optional

filter

Authentication
This operation uses the following authentication methods.
Responses
200

Query cluster response.

Returns cluster of type(s) application/json 
{
    "id": "string",
    "clusterName": "string",
    "clusterType": "string",
    "vsphereClusterName": "string",
    "managementClusterId": "string",
    "hcxUUID": "string",
    "status": "string",
    "activeTasksCount": 0,
    "clusterTemplate": {
        "name": "string",
        "version": "string",
        "id": "string"
    },
    "clusterConfig": {
        "cni": [
            {
                "name": "string"
            }
        ],
        "csi": [
            {
                "name": "string",
                "properties": {
                    "name": "string",
                    "isDefault": false,
                    "serverIP": "string",
                    "mountPath": "string",
                    "datastoreUrl": "string",
                    "timeout": "string"
                }
            }
        ],
        "kubernetesVersion": "string",
        "tools": [
            {
                "name": "string",
                "version": "string"
            }
        ],
        "systemSettings": [
            {
                "name": "string",
                "properties": {
                    "host": "string",
                    "port": 0,
                    "protocol": "string"
                }
            }
        ]
    },
    "clusterId": "string",
    "clusterUrl": "string",
    "kubeConfig": "string",
    "endpointIP": "string",
    "masterNodes": [
        {
            "cpu": 0,
            "memory": 0,
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "nameservers": [
                        "string"
                    ]
                }
            ],
            "storage": 0,
            "replica": 0,
            "labels": [
                "string"
            ],
            "cloneMode": "string"
        }
    ],
    "workerNodes": [
        {
            "cpu": 0,
            "memory": 0,
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "nameservers": [
                        "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
                        }
                    }
                }
            }
        }
    ],
    "vimId": "string",
    "error": "string"
}
string
id
Optional

id

string
clusterName
Optional

clusterName

string
clusterType
Optional

clusterType

string
vsphereClusterName
Optional

vsphereClusterName

string
managementClusterId
Optional

managementClusterId

string
hcxUUID
Optional

hcxUUID

string
status
Optional

status

integer
activeTasksCount
Optional

Number of operations in processing or queued state on the cluster

cluster_clusterTemplate
clusterTemplate
Optional

clusterTemplate

clusterConfig
clusterConfig
Optional

clusterConfig

string
clusterId
Optional

clusterId

string
clusterUrl
Optional

clusterUrl

string
kubeConfig
Optional

kubeConfig

string
endpointIP
Optional

endpointIP

array of cluster_masterNodes
masterNodes
Optional

masterNodes

array of cluster_workerNodes
workerNodes
Optional

workerNodes

string
vimId
Optional

vimId

string
error
Optional

error


400

Bad Request

Returns errorResponse of type(s) application/json 
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


500

Internal Server Error

Returns errorResponse of type(s) application/json 
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


On This Page
Cluster Operations
GET
Get Clusters
GET
Get Cluster Tasks
GET
Get K8 Cluster
POST
Infra Cluster Query
DELETE
Undeploy Infra