Apache CloudStack 4.23.0.0 Root Admin API Reference

listAutoScaleVmProfiles

Lists autoscale Instance profiles.

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 Instance profilefalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
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 false. Resources dedicated to a project are listed only if using the projectid parameter.false
otherdeployparamsThe otherdeployparameters of the autoscale Instance profilefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
serviceofferingidList profiles by service offering idfalse
templateidThe templateid of the autoscale Instance profilefalse
zoneidAvailability zone for the auto deployed Instancefalse

Response Tags

Response NameDescription
idThe autoscale Instance profile ID
accountThe Account owning the Instance group
autoscaleuseridThe ID of the User used to launch and destroy the Instances
domainThe domain name of the Instance profile
domainidThe domain ID of the Instance profile
domainpathpath of the domain to which the vm profile belongs
expungevmgraceperiodThe time allowed for existing connections to get closed before an Instance is destroyed
fordisplayIs profile for display to the regular User
otherdeployparamsParameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance
projectThe project name of the Instance profile
projectidThe project id Instance profile
serviceofferingidThe service offering to be used while deploying an Instance
templateidThe Template to be used while deploying an Instance
userdataBase64 encoded Instance user data
userdatadetailslist of variables and values for the variables declared in userdata
userdataidthe id of userdata used for the VM
userdatanamethe name of userdata used for the VM
userdatapolicythe userdata override policy with the userdata provided while deploying VM
zoneidThe availability zone to be used while deploying an Instance