Get Clusters Node Pools
Api to get node pools for Telco Cloud Automation
Request
URI
GET
https://{api_host}/hybridity/api//infra/k8s/cluster/{clusterId}/nodepools
COPY
Path Parameters
string
clusterId
Required
clusterId
Header Parameters
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. Nodes belonging to a nodepool can be filtered by label with key telco.vmware.com/nodepool and value clustername-nodepoolname
Responses
200
Returns nodepools
Returns
nodePoolList
of type(s)
application/json
{
"items": [
{
"placementParams": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"isNodeCustomizationDeprecated": true,
"memory": 2048,
"replica": 1,
"activeTasksCount": 2,
"warnings": [
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
},
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
}
],
"cpu": 2,
"storage": 5,
"networks": [
{
"networkFullPath": "networkFullPath",
"nameservers": [
"nameservers",
"nameservers"
],
"derivedFromCsar": true,
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2599
},
{
"networkFullPath": "networkFullPath",
"nameservers": [
"nameservers",
"nameservers"
],
"derivedFromCsar": true,
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2599
}
],
"labels": [
"labels",
"labels"
],
"cloneMode": "fullClone",
"nodes": [
{
"vmName": "vmName",
"ip": "ip"
},
{
"vmName": "vmName",
"ip": "ip"
}
],
"name": "name",
"id": "id",
"config": {
"healthCheck": {
"unhealthyConditions": [
{
"type": "Ready",
"timeout": "timeout",
"status": true
},
{
"type": "Ready",
"timeout": "timeout",
"status": true
}
],
"nodeStartupTimeout": "20m0s"
},
"cpuManagerPolicy": {
"type": "kubernetes",
"properties": {
"systemReserved": {
"memoryInGiB": 1,
"cpu": 1
},
"kubeReserved": {
"memoryInGiB": 1,
"cpu": 1
}
},
"policy": "static"
}
},
"errors": [
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
},
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
}
],
"status": "status"
},
{
"placementParams": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"isNodeCustomizationDeprecated": true,
"memory": 2048,
"replica": 1,
"activeTasksCount": 2,
"warnings": [
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
},
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
}
],
"cpu": 2,
"storage": 5,
"networks": [
{
"networkFullPath": "networkFullPath",
"nameservers": [
"nameservers",
"nameservers"
],
"derivedFromCsar": true,
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2599
},
{
"networkFullPath": "networkFullPath",
"nameservers": [
"nameservers",
"nameservers"
],
"derivedFromCsar": true,
"networkName": "networkName",
"label": "label",
"isManagement": true,
"mtu": 2599
}
],
"labels": [
"labels",
"labels"
],
"cloneMode": "fullClone",
"nodes": [
{
"vmName": "vmName",
"ip": "ip"
},
{
"vmName": "vmName",
"ip": "ip"
}
],
"name": "name",
"id": "id",
"config": {
"healthCheck": {
"unhealthyConditions": [
{
"type": "Ready",
"timeout": "timeout",
"status": true
},
{
"type": "Ready",
"timeout": "timeout",
"status": true
}
],
"nodeStartupTimeout": "20m0s"
},
"cpuManagerPolicy": {
"type": "kubernetes",
"properties": {
"systemReserved": {
"memoryInGiB": 1,
"cpu": 1
},
"kubeReserved": {
"memoryInGiB": 1,
"cpu": 1
}
},
"policy": "static"
}
},
"errors": [
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
},
{
"errorCode": "errorCode",
"operationType": "operationType",
"message": "message",
"internalMessage": "internalMessage"
}
],
"status": "status"
}
]
}
array of
nodePool
items
Optional
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, if it has Infrastructure requirements.
On This Page
Infra Operations
POST
Abort Cluster Operation
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
POST
Kuberenetes Version Upgrade Matrix
PUT
Pause Node Pool
POST
Retry Cluster Operation
GET
Supported Kubernetes Versions
PUT
Sync Esx Info
PUT
Unpause Node Pool
PUT
Upgrade Cluster
PUT
Upgrade Cluster Addon
GET
Upgrade History
POST
Upgrade Node Pool
GET
Validate Upgrade Cluster
GET
Vsphere Csi Zone Support