EMemma
Spot instances

Perform actions with a spot instance

This method performs several actions with a spot instance:

  • Start a spot instance
  • Shutdown a spot instance
  • Reboot a spot instance
  • Change price for a spot instance. The price change action allows only an increase in price.
  • Rename a spot instance
post/v1/spot-instances/{spotInstanceId}/actions

Request

  • Base URL
    https://api.emma.ms/external
  • Auth
    HTTP bearer

Path parameters

spotInstanceIdinteger required

ID of the spot instance

Request body

OR
OR
OR
OR

Example request

{
  "action": "reboot"
}

Response

Successful operation

idinteger

ID of the virtual machine

createdAtstring

Date and time when the virtual machine was created

createdByNamestring

Name of the user who created the virtual machine

createdByIdinteger

ID of the user who created the virtual machine

modifiedAtstring

Date and time when the virtual machine was last edited

modifiedByNamestring

Name of the user who last edited the virtual machine

modifiedByIdinteger

ID of the user who last edited the virtual machine

namestring

Name of the virtual machine

projectIdinteger

Project ID

status'POWERED_ON' | 'POWERED_OFF' | 'BUSY' | 'DRAFT'

Status of the virtual machine

vCpuinteger

Number of virtual Central Processing Units (vCPUs)

vCpuType'shared' | 'standard' | 'hpc'

Type of virtual Central Processing Units (vCPUs)

cloudNetworkType'isolated' | 'multi-cloud' | 'default'

Cloud network type

ramGbinteger

Capacity of the RAM in gigabytes

sshKeyIdinteger

SSH key ID

userNamestring

User name

userPasswordstring

Administrator password in the Windows operating system

systemKeyInstalledboolean

Indicates whether the emma system SSH key is installed on the spot instance

Example response

{
  "id": 8100,
  "createdAt": "2021-11-26T14:54:11",
  "createdByName": "Automation User",
  "createdById": 123,
  "modifiedAt": "2021-11-26T14:54:11",
  "modifiedByName": "Automation User",
  "modifiedById": 123,
  "name": "vm-default-e08149hp",
  "projectId": 933,
  "status": "POWERED_ON",
  "provider": {
    "id": 22,
    "name": "GCP"
  },
  "location": {
    "id": 6,
    "name": "London",
    "country": "United Kingdom",
    "continent": "Asia",
    "region": "EMEA",
    "latitude": 51.50735,
    "longitude": -0.1277583
  },
  "dataCenter": {
    "id": "aws-ap-south-1",
    "name": "eu-north-1",
    "providerId": 5,
    "providerName": "GCP",
    "locationId": 35,
    "locationName": "Pune"
  },
  "os": {
    "id": 35,
    "family": "Linux",
    "architecture": "x86-64",
    "type": "Ubuntu",
    "version": "22.04"
  },
  "vCpu": 1,
  "vCpuType": "shared",
  "cloudNetworkType": "multi-cloud",
  "ramGb": 2,
  "disks": [
    {
      "id": 5819,
      "name": "volume-12fg45t",
      "sizeGb": 250,
      "typeId": 2,
      "type": "ssd",
      "isBootable": true,
      "deviceIdentifier": "/dev/sda"
    }
  ],
  "networks": [
    {
      "id": 9826,
      "ip": "10.106.0.2",
      "networkTypeId": 2,
      "networkType": "PRIVATE"
    },
    {
      "id": 9825,
      "ip": "134.122.100.131",
      "networkTypeId": 1,
      "networkType": "PUBLIC"
    }
  ],
  "securityGroup": {
    "id": 208,
    "name": "default"
  },
  "sshKeyId": 123,
  "userName": "root",
  "userPassword": "jsa7235!Hjk",
  "cost": {
    "unit": "HOURS",
    "currency": "EUR",
    "price": 0.002952,
    "minPrice": 0.002952,
    "maxPrice": 0.003152
  },
  "localDisks": [
    {
      "sizeTb": 5,
      "typeId": 2,
      "type": "ssd-plus"
    }
  ],
  "accelerator": {
    "acceleratorTypeId": "53b7db26-4a1b-42f7-97a5-592edd685c5a",
    "acceleratorType": "T4",
    "accelerators": 1,
    "totalGpuMemoryGb": 16
  },
  "tags": [
    {
      "key": "env",
      "value": "dev"
    }
  ],
  "systemKeyInstalled": true,
  "workflowExecutionInfo": {
    "workflowTemplateId": 123,
    "workflowTemplateName": "install-lamp",
    "workflowExists": true,
    "versionName": "v3",
    "versionExists": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.