Apache CloudStack 4.23.0.0 Root Admin API Reference
listAutoScaleVmGroups
Lists autoscale Instance 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 Instance 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 Instances | false |
| vmprofileid | The ID of the profile | false |
| zoneid | The availability zone ID | false |
Response Tags
| Response Name | Description |
| id | The autoscale Instance group ID |
| account | The Account owning the Instance 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 Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group |
| created | The date when this Instance group was created |
| domain | The domain name of the Instance group |
| domainid | The domain ID of the Instance group |
| domainpath | path of the domain to which the vm group belongs |
| 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 Instance Group, The number of Instances in the Instance group will be equal to or less than this number. |
| minmembers | The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number. |
| name | The name of the autoscale Instance group |
| privateport | The private port |
| project | The project name of the Instance group |
| projectid | The project id of the Instance 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 Instance Group |
| vmprofileid | The autoscale profile that contains information about the Instances in the Instance group. |