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

Get status for roll of an Ocean cluster.

URL Parameters

Parameter Type Description
OCEAN_CLUSTER_ID * String

The Ocean cluster to roll.

ROLL_ID * String

The Ocean cluster roll ID

Example: roll-1234
ACCOUNT_ID * String

Your Spot accountId associated with your token.

Attribute Type Description
status String

Set status to roll. Valid values: "STOPPED"

Example: STOPPED
Response - Example 1: 200 with launchSpecIds

Body
Copied!
Downloaded!
{
    "rollId": "roll-1234",
    "oceanId": "o-12e31234",
    "launchSpecIds": ["ols-76694a7d", "ols-56694a76"],
	"progress": {
   		"unit": "percentage",
        "value": 0
	},
    "status": "STOPPED",
    "batchNumber": 3,
	"numOfBatches": 5,
    "comment" : "This is why I deployed my cluster.",
    "createdAt": "2019-03-24T15:46:09.000Z",
    "updatedAt": "2019-03-24T15:46:09.000Z"
 }
Response - Example 2: 200 with instanceNames

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",
  "instanceNames": ["sin-0a4becc0-sig-6952238d", "sin-0542ecc0-sig-695223r4"],
  "createdAt": "2019-03-24T15:50:09.000Z",
  "updatedAt": "2019-03-24T15:46:09.000Z"
}