Update Roll

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in a roll.

put/ocean/gcp/k8s/cluster/{oceanId}/roll/{rollId}

Path parameters

rollIdstring required

Ocean Cluster Roll identifier

Parameters

#/paths/~1azure~1costs/get/parameters/0 — unresolved $ref

#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/get/parameters/1 — unresolved $ref

Request body

Example request

{
  "roll": {
    "status": "STOPPED"
  }
}

Response

Cluster Roll Response

rollIdstring

status'STOPPED'

batchNumberinteger

numOfBatchesinteger

scope'Cluster' | 'Vngs' | 'Vng' | 'Instances' | 'Instance'

batchMinHealthyPercentageinteger

oceanIdstring

respectPdbboolean

createdAtstring

updatedAtstring

Example response

{
  "rollId": "roll-1234",
  "status": "STOPPED",
  "batchNumber": 1,
  "numOfBatches": 5,
  "scope": "Cluster",
  "progress": {
    "unit": "percentage",
    "detailedStatus": {
      "oldInstances": [
        {
          "instanceName": "sin-0a4becc0-sig-1234abcd",
          "status": "REPLACED"
        },
        {
          "instanceName": "sin-1a4becc0-sig-1234abcd",
          "status": "TO_BE_REPLACED"
        },
        {
          "instanceName": "sin-2a4becc0-sig-1234abcd",
          "status": "COULD_NOT_BE_REPLACED"
        },
        {
          "instanceName": "sin-3a4becc0-sig-1234abcd",
          "status": "NOT_REPLACED_DUE_TO_PDB"
        }
      ]
    }
  },
  "batchMinHealthyPercentage": 100,
  "oceanId": "o-12e31234",
  "respectPdb": true,
  "createdAt": "2019-03-24T15:46:09.000Z",
  "updatedAt": "2019-03-24T15:46:09.000Z"
}