Configs

Get the sub-configurations under broker

get/configs/broker

Request

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

Response

Message broker options.

enable_session_registryboolean

Enable session registry

session_locking_strategy'local' | 'leader' | 'quorum' | 'all'

Session locking strategy in a cluster.<br/> - local: only lock the session on the current node<br/> - one: select only one remote node to lock the session<br/> - quorum: select some nodes to lock the session<br/> - all: lock the session on all the nodes in the cluster<br/>

shared_subscription_strategy'random' | 'round_robin' | 'round_robin_per_group' | 'sticky' | 'local' | 'hash_topic' | 'hash_clientid'

Dispatch strategy for shared subscription.<br/> - random: dispatch the message to a random selected subscriber<br/> - round_robin: select the subscribers in a round-robin manner<br/> - sticky: always use the last selected subscriber to dispatch, until the subscriber disconnects.<br/> - hash: select the subscribers by the hash of clientIds<br/>

shared_dispatch_ack_enabledboolean

Deprecated, will be removed in 5.1.<br/>Enable/disable shared dispatch acknowledgement for QoS 1 and QoS 2 messages.<br/>This should allow messages to be dispatched to a different subscriber in the group in case the picked (based on shared_subscription_strategy) subscriber is offline.<br/>

route_batch_cleanboolean

Enable batch clean for deleted routes.

Example response

{
  "shared_subscription_group": {
    "example_group": {
      "strategy": "random"
    }
  }
}

Changes

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