Ocean AWS
Initiate Roll
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.
post/ocean/aws/k8s/cluster/{oceanClusterId}/roll
Parameters
#/paths/~1azure~1costs/get/parameters/0 — unresolved $ref
#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1 — unresolved $ref
Request body
Example request
{
"roll": {
"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"reportPartialCompletion": true
}
}Response
Cluster Roll Response
Example response
{
"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"progress": {
"unit": "percentage",
"detailedStatus": {
"oldInstances": [
{
"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{
"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{
"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
},
{
"instanceId": "i-003a0281a24c01a23",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"oceanId": "o-12e31234",
"instanceIds": [
"i-0003a99ffb566f039",
"i-0567a99ffb566f765"
],
"launchSpecIds": [
"ols-76694a7d",
"ols-56694a76"
],
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"reportPartialCompletion": true,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}