Apache CloudStack v4.4.1 User API Reference


Lists autoscale vm groups.

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idthe ID of the autoscale vm groupfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
lbruleidthe ID of the loadbalancerfalse
listallIf 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 falsefalse
policyidthe ID of the policyfalse
projectidlist objects by projectfalse
vmprofileidthe ID of the profilefalse
zoneidthe availability zone IDfalse

Response Tags

Response NameDescription
idthe autoscale vm group ID
accountthe account owning the instance group
domainthe domain name of the vm profile
domainidthe domain ID of the vm profile
fordisplayis group for display to the regular user
intervalthe frequency at which the conditions have to be evaluated
lbruleidthe load balancer rule ID
maxmembersthe maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.
minmembersthe minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.
projectthe project name of the vm profile
projectidthe project id vm profile
scaledownpolicieslist of scaledown autoscale policies
scaleuppolicieslist of scaleup autoscale policies
statethe current state of the AutoScale Vm Group
vmprofileidthe autoscale profile that contains information about the vms in the vm group.