kubernetes

List node groups

Returns a list of available node groups of an existing Kubernetes cluster. Cluster is identified by given {uuid}.

A node group is a uniform set of worker nodes attached to a cluster.

get/1.3/kubernetes/{uuid}/node-groups

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/kubernetes/{uuid}/node-groups
  • Auth: HTTP bearer

Response

200 getNodeGroups response

countinteger required

Amount of nodes in a node group

namestring required

Name

planstring required

Node group plan

ssh_keysKubernetesSshKey[]

List of public SSH keys

state'failed' | 'pending' | 'running' | 'terminating' | 'unknown' | 'scaling-up' | 'scaling-down'

Node group operational state

storagestring uuid

Storage UUID to use as a template

storage_encryption'data-at-rest' | 'none'

The storage encryption strategy.

anti_affinityboolean

Enable anti-affinity policies

utility_network_accessboolean

Enable utility network access

Example response

[
  {
    "node_updates": {
      "schedule_time": "06:00"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.