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

Roll an Ocean cluster.

Performing this request will start the roll immediately, by defined batches.

Please notice that first response for successful request will notify for starting roll.
In order to check status of roll you can use the GET api using the roll ID.

URL Parameters

Parameter Type Description
OCEAN_CLUSTER_ID * String

The Ocean cluster to roll.

ACCOUNT_ID * String

Your Spotinst accountId associated with your token.

Request

Headers
{
  "Authorization": "Bearer ${token}",
  "Content-Type": "application/json"
}
Body
Copied!
Downloaded!
{ 
	"roll" : 
	{
		"batchSizePercentage" : 20
	}
}
Attribute Type Description
roll Object

Settings for roll operation

roll.batchSizePercentage Integer

Value in % to set size of batch in roll. Valid values are 0-100

Example: 20
Response - 200

Body
Copied!
Downloaded!
{
    "id": "scr-5aaf854e",
    "status": "STARTING",
    "currentBatch": 1,
     "numOfBatches": 5,
     "progress": {
          "unit": "percentage",
          "value": 0
         },
       "oceanId": "o-12e31234",
       "createdAt": "2019-03-24T15:46:09.000Z",
       "updatedAt": "2019-03-24T15:46:09.000Z"
 }