Configs

Get the sub-configurations under cluster

get/configs/cluster

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/configs/cluster
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Response

namestring

Human-friendly name of the EMQX cluster.

discovery_strategy'manual' | 'static' | 'mcast' | 'dns' | 'etcd' | 'k8s'

Service discovery method for the cluster nodes.

core_nodesstring

<br/>List of core nodes that the replicant will connect to.<br/><br/>Note: this parameter only takes effect when the <code>backend</code> is set<br/>to <code>rlog</code> and the <code>role</code> is set to <code>replicant</code>.<br/><br/>This value needs to be defined for manual or static cluster discovery mechanisms.<br/><br/>If an automatic cluster discovery mechanism is being used (such as <code>etcd</code>),<br/>there is no need to set this value.<br/>

autocleanstring

Remove disconnected nodes from the cluster after this interval.

autohealboolean

If <code>true</code>, the node will try to heal network partitions automatically.

proto_dist'inet_tcp' | 'inet6_tcp' | 'inet_tls'

The Erlang distribution protocol for the cluster.

Example response

{
  "core_nodes": "item1,item2",
  "autoclean": "12m",
  "mcast": {
    "sndbuf": "32MB",
    "recbuf": "32MB",
    "buffer": "32MB"
  },
  "etcd": {
    "server": "item1,item2",
    "node_ttl": "12m"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.