core
API
Generated with
core/consul4s/consul4s.v1/consul4s.v1.api/Status

Status

consul4s.v1.api.Status
trait Status[F[_]]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ConsulApi[F]
class ConsulClient[F]
Self type

Members list

Value members

Concrete methods

def getRaftLeader(dc: Option[String], token: Option[String]): F[Result[String]]

GET /status/leader

GET /status/leader

Value parameters

dc
  • Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter.
token
  • Consul token

Attributes

Returns
  • Raft leader for the datacenter in which the agent is running.
def getRaftPeers(dc: Option[String], token: Option[String]): F[Result[List[String]]]

GET /status/peers

GET /status/peers

Value parameters

dc
  • Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter.
token
  • Consul token

Attributes

Returns
  • Raft peers for the datacenter in which the the agent is running. This list of peers is strongly consistent and can be useful in determining when a given server has successfully joined the cluster.
Generated with