Nodes

Get node info

get/nodes/{node}

Request

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

Path parameters

nodestring required

Node name

Response

Get node info successfully

nodestring

Node name

connectionsinteger

Number of clients currently connected to this node

load1number

CPU average load in 1 minute

load5number

CPU average load in 5 minute

load15number

CPU average load in 15 minute

max_fdsinteger

File descriptors limit

memory_totalstring

Allocated memory

memory_usedstring

Used memory

node_status'running' | 'stopped'

Node status

otp_releasestring

Erlang/OTP version

process_availableinteger

Erlang processes limit

process_usedinteger

Running Erlang processes

uptimeinteger

System uptime, milliseconds

versionstring

Release version

edition'Opensource' | 'Enterprise'

Release edition

sys_pathstring

Path to system files

log_pathstring

Path to log files

role'core' | 'replicant'

Node role

Example response

{
  "node": "emqx@127.0.0.1",
  "load1": 2.66,
  "load5": 2.66,
  "load15": 2.66,
  "max_fds": 1024,
  "memory_total": "512.00M",
  "memory_used": "256.00M",
  "node_status": "running",
  "otp_release": "24.2/12.2",
  "process_available": 2097152,
  "process_used": 1024,
  "uptime": 5120000,
  "version": "5.0.0",
  "edition": "Opensource",
  "sys_path": "path/to/emqx",
  "log_path": "path/to/log | The log path is not yet set",
  "role": "core"
}

Changes

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