Apache CloudStack 4.16.0.0 Root Admin API Reference

listKubernetesClusters

Lists Kubernetes clusters

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idthe ID of the Kubernetes clusterfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
namename of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)false
pagefalse
pagesizefalse
projectidlist objects by projectfalse
statestate of the Kubernetes clusterfalse

Response Tags

Response NameDescription
idthe id of the Kubernetes cluster
accountthe account associated with the Kubernetes cluster
associatednetworknamethe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlnodesthe control nodes count for the Kubernetes cluster
cpunumberthe cpu cores of the Kubernetes cluster
descriptionthe description of the Kubernetes cluster
domainthe name of the domain in which the Kubernetes cluster exists
domainidthe ID of the domain in which the Kubernetes cluster exists
endpointURL end point for the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairkeypair details
kubernetesversionidthe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnamethe name of the Kubernetes version for the Kubernetes cluster
masternodesthe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memorythe memory the Kubernetes cluster
minsizeMinimum size of the cluster
namethe name of the Kubernetes cluster
networkidthe ID of the network of the Kubernetes cluster
projectthe project name of the Kubernetes cluster
projectidthe project id of the Kubernetes cluster
serviceofferingidthe ID of the service offering of the Kubernetes cluster
serviceofferingnamethe name of the service offering of the Kubernetes cluster
sizethe size (worker nodes count) of the Kubernetes cluster
statethe state of the Kubernetes cluster
templateidthe ID of the template of the Kubernetes cluster
virtualmachinesthe list of virtualmachine associated with this Kubernetes cluster
zoneidthe name of the zone of the Kubernetes cluster
zonenamethe name of the zone of the Kubernetes cluster