Get All Node Pools

Get All Node Pools

API to fetch all node pools of as Kubernetes Cluster

Request
URI
GET
https://{api_host}/telco/api/caas/v2/clusters/{clusterName}/nodepools
COPY
Path Parameters
string
clusterName
Required

Name of cluster where node pools are created

Query Parameters
string
mgmtClusterName
Optional

Name of management cluster of the given cluster. If given cluster is management cluster, this is not required

string
tcaCpId
Required

TCA-CP id of management cluster managing given cluster

string
filter
Optional

Attribute-based filtering expression.

string
sort
Optional

Attribute based sorting 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.


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully returned node pools

Returns nodepoolList of type(s) application/json
{
    "items": [
        {
            "lastUpdated": "lastUpdated",
            "metadata": {
                "createdByIntent": "createdByIntent",
                "modifiedByIntent": "modifiedByIntent",
                "tcaCpId": "tcaCpId",
                "resourceVersion": 0.8008281904610115,
                "clusterName": "clusterName",
                "name": "name",
                "mgmtClusterName": "mgmtClusterName",
                "annotations": {
                    "templateName": "templateName",
                    "templateNodepoolName": "templateNodepoolName"
                }
            },
            "creationUser": "creationUser",
            "intentQueued": true,
            "creationDate": "creationDate",
            "spec": {
                "template": "template",
                "diskGiB": 5,
                "autoscaler": {
                    "enable": true,
                    "minSize0": 1,
                    "maxSize0": 6
                },
                "numCPUs": 9,
                "datastore": "datastore",
                "replicas": 2,
                "kubeadmConfigTemplate": {
                    "joinConfiguration": {
                        "nodeRegistration": {
                            "kubeletExtraArgs": {
                                "key": "kubeletExtraArgs"
                            }
                        }
                    }
                },
                "cloudMachineTemplate": {
                    "type": "type",
                    "vSphereMachine": {
                        "template": "template",
                        "cloneMode": "fullClone",
                        "numCoresPerSocket": 5,
                        "folder": "folder",
                        "datastore": "datastore",
                        "datacenter": "datacenter",
                        "storagePolicyName": "storagePolicyName",
                        "resourcePool": "resourcePool"
                    }
                },
                "datacenter": "datacenter",
                "storagePolicyName": "storagePolicyName",
                "customisations": {
                    "networkAdapters": [
                        {
                            "networkName": "networkName",
                            "interfaceName": "interfaceName",
                            "mtu": 4.145608029883936
                        },
                        {
                            "networkName": "networkName",
                            "interfaceName": "interfaceName",
                            "mtu": 4.145608029883936
                        }
                    ]
                },
                "memoryMiB": 2,
                "pause": true,
                "labels": {
                    "key": "labels"
                },
                "network": {
                    "devices": [
                        {
                            "dhcp4": true,
                            "nameservers": [
                                "nameservers",
                                "nameservers"
                            ],
                            "dhcp6": true,
                            "networkName": "networkName",
                            "gateway6": "gateway6",
                            "gateway4": "gateway4",
                            "mtu": 7
                        },
                        {
                            "dhcp4": true,
                            "nameservers": [
                                "nameservers",
                                "nameservers"
                            ],
                            "dhcp6": true,
                            "networkName": "networkName",
                            "gateway6": "gateway6",
                            "gateway4": "gateway4",
                            "mtu": 7
                        }
                    ]
                },
                "cloneMode": "fullClone",
                "numCoresPerSocket": 3,
                "folder": "folder",
                "tcaBomReleaseRef": {
                    "name": "name"
                },
                "clusterName": "clusterName",
                "healthCheck": {
                    "unhealthyConditions": [
                        {
                            "type": "type",
                            "timeout": "timeout",
                            "status": "status"
                        },
                        {
                            "type": "type",
                            "timeout": "timeout",
                            "status": "status"
                        }
                    ],
                    "nodeStartupTimeout": "nodeStartupTimeout",
                    "maxUnhealthy": "maxUnhealthy"
                },
                "cloudProvider": {
                    "vimId": "vimId"
                },
                "strategy": {
                    "type": "type",
                    "rollingUpdate": {
                        "maxSurge": "",
                        "maxUnavailable": ""
                    }
                },
                "resourcePool": "resourcePool"
            },
            "status": {
                "needUpgrade": false,
                "deleteAccepted": true,
                "resourceVersion": 7.386281948385884,
                "opstatus": "processing",
                "hostProfile": "hostProfile",
                "computeResource": {
                    "name": "name",
                    "type": "type"
                },
                "conditions": [
                    {
                        "severity": "Warning",
                        "reason": "reason",
                        "lastTransitionTime": "lastTransitionTime",
                        "type": "Ready",
                        "message": "message",
                        "status": true
                    },
                    {
                        "severity": "Warning",
                        "reason": "reason",
                        "lastTransitionTime": "lastTransitionTime",
                        "type": "Ready",
                        "message": "message",
                        "status": true
                    }
                ],
                "pause": false
            }
        },
        {
            "lastUpdated": "lastUpdated",
            "metadata": {
                "createdByIntent": "createdByIntent",
                "modifiedByIntent": "modifiedByIntent",
                "tcaCpId": "tcaCpId",
                "resourceVersion": 0.8008281904610115,
                "clusterName": "clusterName",
                "name": "name",
                "mgmtClusterName": "mgmtClusterName",
                "annotations": {
                    "templateName": "templateName",
                    "templateNodepoolName": "templateNodepoolName"
                }
            },
            "creationUser": "creationUser",
            "intentQueued": true,
            "creationDate": "creationDate",
            "spec": {
                "template": "template",
                "diskGiB": 5,
                "autoscaler": {
                    "enable": true,
                    "minSize0": 1,
                    "maxSize0": 6
                },
                "numCPUs": 9,
                "datastore": "datastore",
                "replicas": 2,
                "kubeadmConfigTemplate": {
                    "joinConfiguration": {
                        "nodeRegistration": {
                            "kubeletExtraArgs": {
                                "key": "kubeletExtraArgs"
                            }
                        }
                    }
                },
                "cloudMachineTemplate": {
                    "type": "type",
                    "vSphereMachine": {
                        "template": "template",
                        "cloneMode": "fullClone",
                        "numCoresPerSocket": 5,
                        "folder": "folder",
                        "datastore": "datastore",
                        "datacenter": "datacenter",
                        "storagePolicyName": "storagePolicyName",
                        "resourcePool": "resourcePool"
                    }
                },
                "datacenter": "datacenter",
                "storagePolicyName": "storagePolicyName",
                "customisations": {
                    "networkAdapters": [
                        {
                            "networkName": "networkName",
                            "interfaceName": "interfaceName",
                            "mtu": 4.145608029883936
                        },
                        {
                            "networkName": "networkName",
                            "interfaceName": "interfaceName",
                            "mtu": 4.145608029883936
                        }
                    ]
                },
                "memoryMiB": 2,
                "pause": true,
                "labels": {
                    "key": "labels"
                },
                "network": {
                    "devices": [
                        {
                            "dhcp4": true,
                            "nameservers": [
                                "nameservers",
                                "nameservers"
                            ],
                            "dhcp6": true,
                            "networkName": "networkName",
                            "gateway6": "gateway6",
                            "gateway4": "gateway4",
                            "mtu": 7
                        },
                        {
                            "dhcp4": true,
                            "nameservers": [
                                "nameservers",
                                "nameservers"
                            ],
                            "dhcp6": true,
                            "networkName": "networkName",
                            "gateway6": "gateway6",
                            "gateway4": "gateway4",
                            "mtu": 7
                        }
                    ]
                },
                "cloneMode": "fullClone",
                "numCoresPerSocket": 3,
                "folder": "folder",
                "tcaBomReleaseRef": {
                    "name": "name"
                },
                "clusterName": "clusterName",
                "healthCheck": {
                    "unhealthyConditions": [
                        {
                            "type": "type",
                            "timeout": "timeout",
                            "status": "status"
                        },
                        {
                            "type": "type",
                            "timeout": "timeout",
                            "status": "status"
                        }
                    ],
                    "nodeStartupTimeout": "nodeStartupTimeout",
                    "maxUnhealthy": "maxUnhealthy"
                },
                "cloudProvider": {
                    "vimId": "vimId"
                },
                "strategy": {
                    "type": "type",
                    "rollingUpdate": {
                        "maxSurge": "",
                        "maxUnavailable": ""
                    }
                },
                "resourcePool": "resourcePool"
            },
            "status": {
                "needUpgrade": false,
                "deleteAccepted": true,
                "resourceVersion": 7.386281948385884,
                "opstatus": "processing",
                "hostProfile": "hostProfile",
                "computeResource": {
                    "name": "name",
                    "type": "type"
                },
                "conditions": [
                    {
                        "severity": "Warning",
                        "reason": "reason",
                        "lastTransitionTime": "lastTransitionTime",
                        "type": "Ready",
                        "message": "message",
                        "status": true
                    },
                    {
                        "severity": "Warning",
                        "reason": "reason",
                        "lastTransitionTime": "lastTransitionTime",
                        "type": "Ready",
                        "message": "message",
                        "status": true
                    }
                ],
                "pause": false
            }
        }
    ]
}
array of nodepool
items
Optional

List of Node Pools


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