Apache CloudStack 4.23.0.0 Root Admin API Reference
createAutoScaleVmProfile
Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.
Request parameters
| Parameter Name | Description | Required |
| serviceofferingid | The service offering of the auto deployed Instance | true |
| templateid | The Template of the auto deployed Instance | true |
| zoneid | Availability zone for the auto deployed Instance | true |
| account | Account that will own the autoscale Instance profile | false |
| autoscaleuserid | The ID of the user used to launch and destroy the Instances | false |
| counterparam | counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 | false |
| domainid | Domain ID of the Account owning an autoscale Instance profile | false |
| expungevmgraceperiod | The time allowed for existing connections to get closed before an Instance is expunged | false |
| fordisplay | An optional field, whether to the display the profile to the end user or not | false |
| otherdeployparams | Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance. Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". | false |
| projectid | An optional project for the autoscale Instance profile | false |
| userdata | An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value | false |
| userdatadetails | used to specify the parameters values for the variables in userdata. | false |
| userdataid | the ID of the Userdata | false |
Response Tags
| Response Name | Description |
| id | The autoscale Instance profile ID |
| account | The Account owning the Instance group |
| autoscaleuserid | The ID of the User used to launch and destroy the Instances |
| domain | The domain name of the Instance profile |
| domainid | The domain ID of the Instance profile |
| domainpath | path of the domain to which the vm profile belongs |
| expungevmgraceperiod | The time allowed for existing connections to get closed before an Instance is destroyed |
| fordisplay | Is profile for display to the regular User |
| otherdeployparams | Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance |
| project | The project name of the Instance profile |
| projectid | The project id Instance profile |
| serviceofferingid | The service offering to be used while deploying an Instance |
| templateid | The Template to be used while deploying an Instance |
| userdata | Base64 encoded Instance 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 an Instance |