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

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in roll.

URL Parameters

ParameterTypeDescription
OCEAN_CLUSTER_ID * String

The Ocean cluster to roll.

ROLL_ID * String

The Ocean cluster roll ID

Example: roll-1234
ACCOUNT_ID * String

Your Spotinst accountId associated with your token.

Request

Headers
{
  "Authorization": "Bearer ${token}",
  "Content-Type": "application/json"
}
Body
Copied!
Downloaded!
{
	"status": "STOPPED"
}
AttributeTypeDescription
status String

Set status to roll. Valid values: "STOPPED"

Example: STOPPED
Response - 200

Body
Copied!
Downloaded!
{
    "rollId": "roll-1234",
    "oceanId": "o-12e31234",
	"progress": {
   		"unit": "percentage",
        "value": 0
	},
    "status": "STOPPED",
    "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"
 }