Apache CloudStack 4.22.0.0 Root Admin API Reference

scaleKubernetesCluster

Scales a created, running or stopped CloudManaged Kubernetes cluster

Request parameters

Parameter Name	Description	Required
id	the ID of the Kubernetes cluster	true
autoscalingenabled	Whether autoscaling is enabled for the cluster	false
maxsize	Maximum number of worker nodes in the cluster	false
minsize	Minimum number of worker nodes in the cluster	false
nodeids	the IDs of the nodes to be removed	false
nodeofferings	(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter	false
serviceofferingid	the ID of the service offering for the virtual machines in the cluster.	false
size	number of Kubernetes cluster nodes	false

Response Tags

Response Name	Description
id	the id of the Kubernetes cluster
account	the account associated with the Kubernetes cluster
associatednetworkname	the name of the network of the Kubernetes cluster
autoscalingenabled	Whether autoscaling is enabled for the cluster
clustertype	the type of the cluster
cniconfigname	Name of CNI Configuration associated with the cluster
cniconfigurationid	ID of CNI Configuration associated with the cluster
consoleendpoint	URL end point for the Kubernetes cluster dashboard UI
controlnodes	the control nodes count for the Kubernetes cluster
controlofferingid	the ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingname	the name of the service offering of the control nodes on the Kubernetes cluster
cpunumber	the cpu cores of the Kubernetes cluster
created	the date when this Kubernetes cluster was created
csienabled	Indicates if the CloudStack CSI driver has been setup in the cluster
description	the description of the Kubernetes cluster
domain	the name of the domain in which the Kubernetes cluster exists
domainid	the ID of the domain in which the Kubernetes cluster exists
domainpath	path of the domain to which the Kubernetes cluster belongs
endpoint	URL end point for the Kubernetes cluster
etcdips	Public IP Addresses of the etcd nodes
etcdnodes	the number of the etcd nodes on the Kubernetes cluster
etcdofferingid	the ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingname	the name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddress	Public IP Address of the cluster
ipaddressid	Public IP Address ID of the cluster
keypair	keypair details
kubernetesversionid	the ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionname	the name of the Kubernetes version for the Kubernetes cluster
masternodes	the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsize	Maximum size of the cluster
memory	the memory the Kubernetes cluster
minsize	Minimum size of the cluster
name	the name of the Kubernetes cluster
networkid	the ID of the network of the Kubernetes cluster
project	the project name of the Kubernetes cluster
projectid	the project id of the Kubernetes cluster
serviceofferingid	the ID of the service offering of the Kubernetes cluster
serviceofferingname	the name of the service offering of the Kubernetes cluster
size	the size (worker nodes count) of the Kubernetes cluster
state	the state of the Kubernetes cluster
templateid	the ID of the template of the Kubernetes cluster
templatename	the name of the template of the Kubernetes cluster
virtualmachines	the list of virtualmachine associated with this Kubernetes cluster
workerofferingid	the ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingname	the name of the service offering of the worker nodes on the Kubernetes cluster
zoneid	the name of the zone of the Kubernetes cluster
zonename	the name of the zone of the Kubernetes cluster

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.