List the node pools of a Kubernetes cluster
Retrieve the list of node pools of a Kubernetes cluster.
Permissions
info
This action requires the following IAM (Identity and Access Management) permissions:
- kubernetes.cluster.get
- Console
- API
-
From the left-hand side menu, click Managed Services → Kubernetes to access the list of Kubernetes clusters.
-
Click the name of a cluster to access its details page.
-
The Node pools section displays the list of the cluster's node pools with their information:
- Node pool name
- Status
- Availability Zone
- Node type
- System volume
- Number of nodes
The status of a node pool can take the following values:
| Status | Description |
|---|---|
| In progress | The node pool is operating normally |
| Pending | The node pool is being created or updated |
| Failed | An error has occurred |
Use the GET /kubernetes/spaces/{spaceId}/clusters/{clusterId}/nodePools route to list the node pools of a Kubernetes cluster.
Example response
{
"items": [
{
"id": "nodepool-001-e29b-41d4",
"name": "worker-nodepool-1",
"availabilityZone": "eu-west-2a",
"nodeProfile": "medium",
"replicas": 3,
"rootDisk": {
"size": 50,
"iops": 3000,
"type": "enterprise"
},
"status": {
"state": "RUNNING",
"message": "NodePool is healthy"
}
}
]
}