spot-api

This API provides simple restful API access to SpotInst Spot market services.

Endpoints

GET /v1/spot/ping
GET /v1/spot/version
GET /v1/spot/metrics

GET /v1/spot/{account}/elastigroups
POST /v1/spot/{account}/elastigroups
GET /v1/spot/{account}/elastigroups/{elastigroup}
PUT /v1/spot/{account}/elastigroups/{elastigroup}
DELETE /v1/spot/{account}/elastigroups/{elastigroup}

GET /v1/spot/{account}/instances
POST /v1/spot/{account}/instances
GET /v1/spot/{account}/instances/{instance}
GET /v1/spot/{account}/instances/{instance}/costs[?start=2021-05-01&end=2021-05-18]
GET /v1/spot/{account}/instances/{instance}/status
PUT /v1/spot/{account}/instances/{instance}
DELETE /v1/spot/{account}/instances/{instance}

Examples

Elastigroups

Example request body of new elastigroup (POST):

{
  "name": "test202018",
  "strategy": {
    "risk": 100,
    "onDemandCount": null,
    "availabilityVsCost": "balanced",
    "drainingTimeout": 120,
    "fallbackToOd": true,
    "scalingStrategy": {
      "terminationPolicy": "newestInstance"
    },
    "lifetimePeriod": "days",
    "revertToSpot": {
      "performAt": "always"
    },
    "persistence": {}
  },
  "capacity": {
    "target": 2,
    "minimum": 2,
    "maximum": 4,
    "unit": "instance"
  },
  "scaling": {
    "up": null,
    "down": null
  },
  "compute": {
    "instanceTypes": {
      "ondemand": "t3.micro",
      "spot": [
	    "t3.micro",
	    "t3a.micro",
	    "t3a.nano",
	    "t3.nano"
      ]
    },
    "availabilityZones": [
      {
        "name": "us-east-1a",
        "subnetId": "subnet-00000000000000000"
      }
    ],
    "product": "Linux/UNIX",
    "launchSpecification": {
      "securityGroupIds": [
        "sg-00000000000000000"
      ],
      "monitoring": false,
      "ebsOptimized": false,
      "imageId": "ami-00000000000000000",
      "keyPair": "user",
      "healthCheckType": null,
      "tenancy": "default",
      "userData": null,
      "shutdownScript": null
    },
    "elasticIps": null,
    "preferredAvailabilityZones": null
  },
  "multai": null,
  "scheduling": {},
  "region": "us-east-1",
  "thirdPartiesIntegration": {}
}

Example request body of elastigroup update (PUT):

{
  "id": "sig-000000000",
  "capacity": {
    "target": 2,
    "minimum": 2,
    "maximum": 4
  },
  "compute": {
    "instanceTypes": {
      "ondemand": "t3.micro",
      "spot": [
  	    "t3.micro",
        "t3a.micro",
        "t3a.nano",
        "t3.nano"
      ]
    },
    "launchSpecification": {
      "tags": [
        { 
          "tagKey": "food",
          "tagValue": "good"
        }
      ]
    }
  }
}

Managed Instances

Example request body of new managed instance (POST):

{
  "region": "us-east-1",
  "name": "mi-test",
  "description": "My new Spot Instance",
  "strategy": {
    "revertToSpot": {
      "performAt": "always"
    }
  },
  "persistence": {
    "persistPrivateIp": true,
    "persistBlockDevices": true,
    "persistRootDevice": true,
    "blockDevicesMode": "onLaunch"
  },
  "healthCheck": {
    "type": "EC2",
    "autoHealing": true,
    "gracePeriod": 120,
    "unhealthyDuration": 120
  },
  "compute": {
    "product": "Linux/UNIX",
    "subnetIds": [
      "subnet-0123456789abcdef0"
    ],
    "vpcId": "vpc-0123456789abcdef0",
    "launchSpecification": {
      "instanceTypes": {
        "preferredType": "t3a.micro",
        "types": [
          "t3a.micro",
          "t3.micro",
          "t2.micro"
        ]
      },
      "securityGroupIds": [
        "sg-0123456789abcdef0"
      ],
      "imageId": "ami-02354e95b39ca8dec",
      "keyPair": null,
      "tags": [
        {
          "tagKey": "CreatedBy",
          "tagValue": "me"
        }
      ],
      "networkInterfaces": [
        {
          "associateIpv6Address": false,
          "deviceIndex": 0
        }
      ],
      "creditSpecification": {
        "cpuCredits": "standard"
      },
      "shutdownScript": null,
      "userData": null
    },
    "privateIp": null
  },
  "integrations": {},
  "scheduling": {}
}

Example request body of managed instance update (PUT):

{
  "compute": {
    "launchSpecification": {
      "tags": [
        {
          "tagKey": "Environment",
          "tagValue": "dev"
        }
      ]
    }
  }
}

Get the costs and savings for a managed instance

By default, this will get all the incurred costs for a managed instance. You can specify start and end dates to get the costs for a period of time.

GET /v1/spot/{account}/instances/{instance}/costs?start=2021-05-10&end=2021-05-15

{
    "costs": {
        "actual": 0.1581,
        "potential": 0.4794
    },
    "running": {
        "unit": "hours",
        "value": 51
    },
    "savings": {
        "unit": "percentage",
        "value": 67.0213
    }
}

Authentication

Authentication is accomplished using a pre-shared key (hashed string) in the X-Auth-Token header.

Author

E Camden Fisher [email protected] Tenyo Grozev [email protected]

License

GNU Affero General Public License v3.0 (GNU AGPLv3)
Copyright (c) 2021 Yale University