Operations of all clusters

GET

/api/v1/operations

const url = 'http://localhost:8080/api/v1/operations';
const options = {method: 'GET', headers: {cookie: 'brokerium_session=<brokerium_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/operations \
  --cookie brokerium_session=<brokerium_session>

Role: viewer.

Authorizations

sessionCookie
bearerToken

Parameters

Query Parameters

limit

integer

>= 1 <= 1000

Responses

200

Operations, newest first.

application/json

object

operations

Array<object>

object

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>

sizeBytes

integer format: int64

replicaMoves

integer

leaderChange

boolean

before

object

brokers

Array<object>

object

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

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

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

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.