Apache CloudStack 4.15.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 |
| 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 | 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 | 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 |
| consoleendpoint | URL end point for the Kubernetes cluster dashboard UI |
| cpunumber | the cpu cores of the Kubernetes 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 |
| endpoint | URL end point for 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 |
| memory | the memory the Kubernetes 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 |
| virtualmachines | the list of virtualmachine associated with this Kubernetes cluster |
| zoneid | the name of the zone of the Kubernetes cluster |
| zonename | the name of the zone of the Kubernetes cluster |