Plan an operation (dry run)

POST

/api/v1/clusters/{id}/operations

curl --request POST \
  --url http://localhost:8080/api/v1/clusters/example/operations \
  --header 'Content-Type: application/json' \
  --header 'X-Brokerium-Request: 1' \
  --cookie brokerium_session=<brokerium_session> \
  --data '{ "type": "rebalance", "params": {} }'

• Local development server

Role: operator. Returns a planned operation with its plan and steps. Nothing changes in the cluster until the operation is confirmed. Plans expire after 15 minutes.

Authorizations

• sessionCookie
• bearerToken

Parameters

Path Parameters

id

required

string

Header Parameters

X-Brokerium-Request

required

string

Allowed value: 1

Required on every non-GET request.

Request Body^required

Media typeapplication/json

object

type

required

string

params

Parameters of the operation type, see OperationParams.

object

Responses

201

Planned operation.

Media typeapplication/json

object

id

string

clusterId

string

type

string

status

string

Allowed values: planned pending running paused succeeded failed cancelled

summary

string

params

object

plan

object

summary

string

warnings

Array<string>

irreversible

boolean

moves

Array<object>

object

topic

string

partition

integer

from

Array<integer>

to

Array<integer>

sizeBytes

integer format: int64

replicaMoves

integer

leaderChange

boolean

before

object

brokers

Array<object>

object

id

integer

rack

string

replicas

integer

leaders

integer

dataBytes

integer format: int64

bytesInPerSec

number

excluded

boolean

replicaSpread

integer

leaderSpread

integer

dataSpreadBytes

integer format: int64

score

number

after

object

brokers

Array<object>

object

id

integer

rack

string

replicas

integer

leaders

integer

dataBytes

integer format: int64

bytesInPerSec

number

excluded

boolean

replicaSpread

integer

leaderSpread

integer

dataSpreadBytes

integer format: int64

score

number

dataToMoveBytes

integer format: int64

details

object

irreversible

boolean

currentStep

integer

requestedAction

string

error

string

createdBy

string

createdAt

string format: date-time

startedAt

string | null format: date-time

finishedAt

string | null format: date-time

updatedAt

string format: date-time

steps

Array<object>

object

index

integer

name

string

kind

string

args

alwaysRun

boolean

status

string

Allowed values: pending running succeeded failed skipped

detail

error

string

startedAt

string | null format: date-time

finishedAt

string | null format: date-time

Example

{
  "status": "planned",
  "steps": [
    {
      "status": "pending"
    }
  ]
}

400

Error.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Error.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}