Apache CloudStack 4.18.0.0 Root Admin API Reference
listAutoScaleVmGroups
Lists autoscale vm groups.
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 |
| fordisplay | list resources by display flag; only ROOT admin is eligible to pass this parameter | false |
| id | the ID of the autoscale vm group | 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 |
| lbruleid | the ID of the loadbalancer | 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 | the name of the autoscale vmgroup | false |
| page | false | |
| pagesize | false | |
| policyid | the ID of the policy | false |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| vmprofileid | the ID of the profile | false |
| zoneid | the availability zone ID | false |
Response Tags
| Response Name | Description |
| id | the autoscale vm group ID |
| account | the account owning the vm group |
| associatednetworkid | the id of the guest network the lb rule belongs to |
| associatednetworkname | the name of the guest network the lb rule belongs to |
| availablevirtualmachinecount | the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup |
| created | the date when this vm group was created |
| domain | the domain name of the vm group |
| domainid | the domain ID of the vm group |
| fordisplay | is group for display to the regular user |
| interval | the frequency at which the conditions have to be evaluated |
| lbprovider | the lb provider of the guest network the lb rule belongs to |
| lbruleid | the load balancer rule ID |
| maxmembers | the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. |
| minmembers | the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. |
| name | the name of the autoscale vm group |
| privateport | the private port |
| project | the project name of the vm group |
| projectid | the project id of the vm group |
| publicip | the public ip address |
| publicipid | the public ip address id |
| publicport | the public port |
| scaledownpolicies | list of scaledown autoscale policies |
| scaleuppolicies | list of scaleup autoscale policies |
| state | the current state of the AutoScale Vm Group |
| vmprofileid | the autoscale profile that contains information about the vms in the vm group. |