Apache CloudStack 4.14.1.0-SNAPSHOT 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 | false |
| page | false | |
| pagesize | false | |
| policyid | the ID of the policy | false |
| projectid | list objects by project | 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 instance group |
| domain | the domain name of the vm profile |
| domainid | the domain ID of the vm profile |
| fordisplay | is group for display to the regular user |
| interval | the frequency at which the conditions have to be evaluated |
| 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. |
| project | the project name of the vm profile |
| projectid | the project id vm profile |
| 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. |