Apache CloudStack 4.23.0.0 Root Admin API Reference
createAutoScaleVmGroup
Creates and automatically starts an Instance based on a service offering, disk offering, and Template.
Request parameters
| Parameter Name | Description | Required |
| lbruleid | The ID of the load balancer rule | true |
| 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. | true |
| 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. | true |
| scaledownpolicyids | List of scaledown autoscale policies | true |
| scaleuppolicyids | List of scaleup autoscale policies | true |
| vmprofileid | The autoscale profile that contains information about the Instances in the Instance group. | true |
| fordisplay | An optional field, whether to the display the group to the end user or not | false |
| interval | The frequency in which the performance counters to be collected | false |
| name | The name of the autoscale Instance Group | 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. |