Request parameters
| Parameter Name | Description | Required |
| clustername | the cluster name | true |
| clustertype | type of the cluster: CloudManaged, ExternalManaged | true |
| hypervisor | hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator | true |
| podid | the Pod ID for the host | true |
| zoneid | the Zone ID for the cluster | true |
| allocationstate | Allocation state of this cluster for allocation of new resources | false |
| password | the password for the host | false |
| url | the URL | false |
| username | the username for the cluster | false |
| vsmipaddress | the ipaddress of the VSM associated with this cluster | false |
| vsmpassword | the password for the VSM associated with this cluster | false |
| vsmusername | the username for the VSM associated with this cluster | false |
Response Tags
| Response Name | Description |
| id | the cluster ID |
| allocationstate | the allocation state of the cluster |
| clustertype | the type of the cluster |
| hypervisortype | the hypervisor type of the cluster |
| managedstate | whether this cluster is managed by cloudstack |
| name | the cluster name |
| podid | the Pod ID of the cluster |
| podname | the Pod name of the cluster |
| zoneid | the Zone ID of the cluster |
| zonename | the Zone name of the cluster |
| capacity(*) | the capacity of the Cluster |
| capacitytotal | the total capacity available |
| capacityused | the capacity currently in use |
| clusterid | the Cluster ID |
| clustername | the Cluster name |
| percentused | the percentage of capacity currently in use |
| podid | the Pod ID |
| podname | the Pod name |
| type | the capacity type |
| zoneid | the Zone ID |
| zonename | the Zone name |