Apache CloudStack 4.23.0.0 Root Admin API Reference
listKubernetesClusters
Lists Kubernetes clusters
Request parameters
| Parameter Name | Description | Required |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| clustertype | Type of the cluster: CloudManaged, ExternalManaged | false |
| domainid | List only resources belonging to the domain specified | false |
| id | The ID of the Kubernetes cluster | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If 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 false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| name | Name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned) | false |
| page | false | |
| pagesize | false | |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| state | State of the Kubernetes cluster | 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 |
| controlaffinitygroupids | The IDs of affinity groups associated with control nodes |
| controlaffinitygroupnames | The names of affinity groups associated with control nodes |
| 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 |
| etcdaffinitygroupids | The IDs of affinity groups associated with etcd nodes |
| etcdaffinitygroupnames | The names of affinity groups associated with etcd nodes |
| 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 virtualmachines associated with this Kubernetes cluster |
| workeraffinitygroupids | The IDs of affinity groups associated with worker nodes |
| workeraffinitygroupnames | The names of affinity groups associated with worker nodes |
| 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 |