fbpx
POSThttps://api.spotinst.io/ocean/gcp/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

ParameterTypeDescription
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,
        "comment": "This is why I deployed my cluster."
    }
}
AttributeTypeDescription
batchSizePercentage Integer

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

Example: 20
comment String

Add a comment description for the roll. comment should be limit to 256 chars.

Response - 200

Body
Copied!
Downloaded!
{
    "rollId": "roll-1234",
    "oceanId": "o-12e31234",
	"progress": {
   		"unit": "percentage",
        "value": 0
	},
    "status": "STARTING",
    "batchNumber": 1,
	"numOfBatches": 5,
    "comment" : "This is why I deployed my cluster.",
    "createdAt": "2019-03-24T15:46:09.000Z",
    "updatedAt": "2019-03-24T15:46:09.000Z"
 }