The /operator/area endpoints provide tools to manage network areas via
Consul's HTTP API.
The network area functionality described here is available only in
Consul Enterprise version 0.8.0 and
later. Network areas are operator-defined relationships between servers in two
different Consul datacenters.
Unlike Consul's WAN feature, network areas use just the server RPC port for
communication, and relationships can be made between independent pairs of
datacenters, so not all servers need to be fully connected. This allows for
complex topologies among Consul datacenters like hub/spoke and more general
dc(string: "") - Specifies the datacenter to query. This will default to
the datacenter of the agent being queried. This is specified as a URL query
PeerDatacenter(string: <required>) - Specifies the name of the Consul
datacenter that will be joined the Consul servers in the current datacenter to
form the area. Only one area is allowed for each possible PeerDatacenter,
and a datacenter cannot form an area with itself.
RetryJoin(array<string>: nil)- Specifies a list of Consul servers to
attempt to join. Servers can be given as IP, IP:port, hostname, or
hostname:port. Consul will spawn a background task that tries to
periodically join the servers in this list and will run until a join succeeds.
If this list is not supplied, joining can be done with a call to the
join endpoint once the network area is created.
UseTLS(bool: <optional>) - Specifies whether gossip over this area should be
encrypted with TLS if possible.
Joined will be true if the Consul server at the given address was
successfully joined into the network area. Otherwise, this will be false and
Error will have a human-readable message about why the join didn't succeed.
Status is the current health status of the node, as determined by the
network area distributed failure detector. This will be "alive", "leaving",
"left", or "failed". A "failed" status means that other servers are not able
to probe this server over its server RPC interface.
RTT is an estimated network round trip time from the server answering the
query to the given server, in nanoseconds. This is computed using network