Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

  • X-IBC-SECRET: <customer secret> - your Customer Secret.

    > To find your Customer Secret:
    - If you used full permissions when you logged in and activate the integration of IncrediBuild Cloud – cloud provider:
    [For both AWS and Azure] Retrieve your Customer Secret from the registry:
    HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Xoreax\IncrediBuild\Coordinator\IncrediCloudSubscriptionKey
    - If you used low permissions when you logged in and activate the integration of IncrediBuild Cloud – cloud provider:
    - For AWS - your External ID from AWS Console. See: Obtaining the Required AWS Login Details
    - For Azure – your Client Secret form Azure portal. See: Obtaining the Required Azure Login Details

  • 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.

...