GEThttps://api.spotinst.io/ocean/aws/k8s/cluster/{OCEAN_CLUSTER_ID}/roll?accountId={ACCOUNT_ID}

Get status for all rolls of an Ocean cluster.

URL Parameters

Parameter Type Description
OCEAN_CLUSTER_ID * String

The Id of the Ocean cluster to get rolls.

Example: o-12345678
ACCOUNT_ID * String

Your Spot accountId associated with your token.

Response - 200

Body
Copied!
Downloaded!
{
    "status": {
      "code": 200,
      "message": "OK"
    },
    "kind": "spotinst:ocean:aws:k8s:cluster:roll",
    "items": [
      {
        "id": "scr-7051c22e",
        "status": "IN_PROGRESS",
        "currentBatch": 2,
        "numOfBatches": 2,
        "progress": {
          "unit": "percentage",
          "value": 50
        },
        "oceanId": "o-30681b13",
        "launchSpecIds": ["ols-76694a7d", "ols-56694a76"],
        "comment": "Scheduled cluster roll for o-30681b13",
        "createdAt": "2020-04-16T12:00:36.000Z",
        "updatedAt": "2020-04-16T12:00:07.000Z"
      },
      {
        "id": "scr-9534365e",
        "status": "COMPLETED",
        "currentBatch": 2,
        "numOfBatches": 2,
        "progress": {
          "unit": "percentage",
          "value": 100
        },
        "oceanId": "o-30681b13",
        "launchSpecIds": ["ols-76345a7d", "ols-56888a76"],
        "createdAt": "2020-04-16T12:00:28.000Z",
        "updatedAt": "2020-04-16T12:00:10.000Z"
      }
    ],
    "count": 2
  }
}
Response - 200 with instanceIds

Body
Copied!
Downloaded!
{
  "id": "scr-123456789",
  "status": "STOPPED",
  "currentBatch": 3,
  "numOfBatches": 5,
  "comment" : "This is why I deployed my cluster.",
  "progress": {
    "unit": "percentage",
    "value": 40
  },
  "oceanId": "o-12345678",
  "instanceIds": ["i-0003a99ffb566f039", "i-0567a99ffb566f765"],
  "createdAt": "2019-03-24T15:50:09.000Z",
  "updatedAt": "2019-03-24T15:46:09.000Z"
}