You can use an API call to start Helper VMs from the pool at any time, in preparation for a task execution. Normally, IncrediBuild Cloud automatically starts VMs from the pool upon the execution of a task, in order to enable its acceleration. The VM starting process can take some time, and therefore in certain cases you may want to shorten the response time of the VMs, and to initiate the VM starting process before you actually execute your task. This way, the Helper VMs will be already up and running once you begin your task execution, and your acceleration results will be optimized.
IncrediBuild Cloud provides you with an API, which is designed to start Helper VMs from the pool on-demand. This API is a standard REST API, with a public endpoint URL and an HTTP header to allow authentication. The API can be called via any HTTP client or REST API client (such as the REST API Client tool embedded in Visual studio, Postman, cURL command line, and others).
When preparing the API call, you specify via the coreReq parameter the number of cores you want to start. According to the number of cores of the VM type you are using, a corresponding number of VMs will be started. For example, if you are using a VM type that has 2 cores, and you are requesting 8 cores, 4 VMs will be started. If you are using a VM type that has 16 cores, and you are requesting 8 cores, one VM will be started.
Following your request, IncrediBuild Cloud will start VMs that are in the pool in a Stopped state, or allocate active pool VMs that are no longer used by other tasks. The number of started VMs will be limited by the number of VMs in your pool. Upon the completion of the task execution, IncrediBuild Cloud will automatically stop the running VMs that were started for this task.
Request Syntax
| Code Block |
|---|
POST https://incredicloudapim-prod.azure-api.net/provision/setWakeupMachines/ HTTP/1.1
Content-type: application/json
X-IBC-SECRET: <”customer secret”>
{
"coordId": "string",
"coreReq": "number"
} |
Request Body
The request accepts the following data:
...
coordId – your Coordinator ID. See: Locating Your Coordinator License ID
...
coreReq – the number of cores you want to start. Enter a numeric value as follows:
- A value of 0 – will start all the VMs in the pool that are in a Stopped state.
- A value greater than 0 - will start VMs from the pool according to number of specified cores.
Note: If the number of requested cores is lower than the number of cores in the VM type you are using, the number of cores will be rounded up to the used VM type. For example, if you requested 24 cores, but you are using a VM type that has 32 cores, one VM with 32 cores will be started.
Response Syntax
| Code Block |
|---|
Success
HTTP/1.1 200
Content-type: application/json
{
machinesToWakeUp : []
} |
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned:
machinesToWakeUp - a list of the VM names that were started following your request.
...