Apache CloudStack 4.20.0.0 Root Admin API Reference
listAutoScaleVmProfiles
Lists autoscale vm profiles.
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 profile | 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 |
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 |
otherdeployparams | the otherdeployparameters of the autoscale vm profile | false |
page | false | |
pagesize | false | |
projectid | list objects by project; if projectid=-1 lists All VMs | false |
serviceofferingid | list profiles by service offering id | false |
templateid | the templateid of the autoscale vm profile | false |
zoneid | availability zone for the auto deployed virtual machine | false |
Response Tags
Response Name | Description |
id | the autoscale vm profile ID |
account | the account owning the instance group |
autoscaleuserid | the ID of the user used to launch and destroy the VMs |
domain | the domain name of the vm profile |
domainid | the domain ID of the vm profile |
domainpath | path of the domain to which the vm profile belongs |
expungevmgraceperiod | the time allowed for existing connections to get closed before a vm is destroyed |
fordisplay | is profile for display to the regular user |
otherdeployparams | parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine |
project | the project name of the vm profile |
projectid | the project id vm profile |
serviceofferingid | the service offering to be used while deploying a virtual machine |
templateid | the template to be used while deploying a virtual machine |
userdata | Base64 encoded VM user data |
userdatadetails | list of variables and values for the variables declared in userdata |
userdataid | the id of userdata used for the VM |
userdataname | the name of userdata used for the VM |
userdatapolicy | the userdata override policy with the userdata provided while deploying VM |
zoneid | the availability zone to be used while deploying a virtual machine |