SPspot
Ocean AWS

Update Roll

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in a roll.

put/ocean/aws/k8s/cluster/{oceanClusterId}/roll/{ROLL_ID}

Request

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

Path parameters

oceanClusterIdstring required

The identifier of the Ocean cluster

ROLL_IDstring required

Ocean cluster roll identifier

Parameters

#/paths/~1azure~1costs/get/parameters/0 (unresolved $ref)

Request body

Example request

{
  "roll": {
    "status": "STOPPED"
  }
}

Response

Cluster Roll Response

idstring
scope'Cluster' | 'Vngs' | 'Vng' | 'Instances' | 'Instance'
status'STOPPED'
currentBatchinteger
numOfBatchesinteger
oceanIdstring
respectPdbboolean
batchMinHealthyPercentageinteger
createdAtstring
updatedAtstring

Example response

{
  "id": "scr-5aaf854e",
  "scope": "Cluster",
  "status": "STOPPED",
  "currentBatch": 1,
  "numOfBatches": 5,
  "progress": {
    "unit": "percentage",
    "detailedStatus": {
      "oldInstances": [
        {
          "instanceId": "i-003a0281a24c01a20",
          "status": "REPLACED"
        },
        {
          "instanceId": "i-003a0281a24c01a21",
          "status": "TO_BE_REPLACED"
        },
        {
          "instanceId": "i-003a0281a24c01a22",
          "status": "COULD_NOT_BE_REPLACED"
        },
        {
          "instanceId": "i-003a0281a24c01a23",
          "status": "NOT_REPLACED_DUE_TO_PDB"
        }
      ]
    }
  },
  "oceanId": "o-12e31234",
  "respectPdb": true,
  "batchMinHealthyPercentage": 100,
  "createdAt": "2019-03-24T15:46:09.000Z",
  "updatedAt": "2019-03-24T15:46:09.000Z"
}

Changes

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