Get cluster topology

GET 
/topology

Obtains the current topology of the cluster the gateway is part of.

Request

Responses

200

Obtains the current topology of the cluster the gateway is part of.

application/json

Schema

Schema

brokers object[]nullable
A list of brokers that are part of this cluster.
Array [
nodeId int32
The unique (within a cluster) node ID for the broker.
host string
The hostname for reaching the broker.
port int32
The port for reaching the broker.
partitions object[]
A list of partitions managed or replicated on this broker.
Array [
partitionId int32
The unique ID of this partition.
role string
Possible values: [leader, follower, inactive]
Describes the Raft role of the broker for a given partition.
health string
Possible values: [healthy, unhealthy, dead]
Describes the current health of the partition.
]
version string
The broker version.
]
clusterSize int32nullable

The number of brokers in the cluster.

partitionsCount int32nullable

The number of partitions are spread across the cluster.

replicationFactor int32nullable

The configured replication factor for this cluster.

gatewayVersion stringnullable

The version of the Zeebe Gateway.

Example (from schema)

{
  "brokers": [
    {
      "nodeId": 0,
      "host": "string",
      "port": 0,
      "partitions": [
        {
          "partitionId": 0,
          "role": "leader",
          "health": "healthy"
        }
      ],
      "version": "string"
    }
  ],
  "clusterSize": 0,
  "partitionsCount": 0,
  "replicationFactor": 0,
  "gatewayVersion": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...