SPspot
Ocean ECS

Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately according to defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API using the roll identifier.

post/ocean/aws/ecs/cluster/{oceanClusterId}/roll

Request

  • Base URL
    https://api.spotinst.io
  • URL
    https://api.spotinst.io/ocean/aws/ecs/cluster/{oceanClusterId}/roll
  • Auth
    HTTP bearer

Parameters

#/paths/~1azure~1costs/get/parameters/0 (unresolved $ref)
#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1 (unresolved $ref)

Request body

OR
object required
OR
object required

Example request

{
  "roll": {
    "batchSizePercentage": 20,
    "comment": "This is why I rolled my cluster.",
    "batchMinHealthyPercentage": 100
  }
}

Response

(unresolved $ref)

Changes

No recorded changes to this operation across all 12 revisions of this API.