Skip to main content
Version: Next

Get cluster topology

GET 

/topology

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

Request

Responses

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

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.

Loading...