Apache CloudStack 4.18.0.0 Root Admin API Reference
createAutoScaleVmGroup
Creates and automatically starts a virtual machine 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 vmgroup, The number of instances in the vm group will be equal to or less than this number. | true |
| 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. | true |
| scaledownpolicyids | list of scaledown autoscale policies | true |
| scaleuppolicyids | list of scaleup autoscale policies | true |
| vmprofileid | the autoscale profile that contains information about the vms in the vm 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 vmgroup | 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. |