getOrgMxEdgesStats

GET https://{{host}}/api/v1/orgs/:org_id/stats/mxedges

Query Parameters

NameTypeDescription
for_sitebooleantrue / false/ any (default false). Filter for site level mist edges

Response Parameters

ParameterTypeDescription
namestringThe name of the tunnel
virtualization_typestringVirtualization environment
memory_statsobjectMemory usage
totalintTotal amount of usable RAM, in kibibytes, which is physical RAM minus a number of reserved bits and the kernel binary code.
freeintThe amount of physical RAM, in kibibytes, left unused by the system.
availableintAn estimate of how much memory is available for starting new applications, without swapping.
buffersintThe amount, in kibibytes, of temporary storage for raw disk blocks.
cachedintThe amount of physical RAM, in kibibytes, used as cache memory.
swap_cachedintThe amount of memory, in kibibytes, that has once been moved into swap, then back into the main memory, but still also remains in the swapfile.
activeintThe amount of memory, in kibibytes, that has been used more recently and is usually not reclaimed unless absolutely necessary.
inactiveintThe amount of memory, in kibibytes, that has been used less recently and is more eligible to be reclaimed for other purposes.
swap_totalintThe total amount of swap available, in kibibytes.
swap_freeintThe total amount of swap free, in kibibytes.
cpu_statobjectCPU/core stats list
usageintpercentage of load, Busy/(Idle + Busy) since last sampling
userfloatpercentage of User, User/(Idle + Busy) since last sampling
systemfloatpercentage of System, System/(Idle + Busy) since last sampling
idlefloatpercentage of Idle, Idle/(Idle + Busy) since last sampling
interruptfloatpercentage of Interrupt, (Irq + SoftIrq)/(Idle + Busy) since last sampling
ip_statobjectOOBM IP stats
ipsobjectIPs for each net interface
macsobjectMAC addresses for each net interface
service_statobjectstat for each services
ext_ipstringexternal IP from ep-terminator’s point of view. valid only for service having its own cloud connection
last_seeninttimestamp when the last stats is seen (cloud unix time, in second). valid only for service having its own stats or whole system (last among last_seen of all services)
uptimeintservice or system uptime.
package_statestringpackage/service installation state.
package_versionstringpackage/service installation state.
running_statestringservice running state.
lag_statobjectstat for LAG (Link Aggregation Group)
distrostringdebian code name(buster, bullseye)
fips_enabledboolvalue indicating fips configuration on the device

RESPONSES

status: OK

[{"sensor_stat":{},"memory_stat":{"total":8365957120,"free":4330659840,"usage":48,"available":4699291648,"buffers":107646976,"cached":478060544,"swap_cached":0,"active":394936320,"inactive":211980288,"swap_total":1022357504,"swap_free":1022357504},"ip_stat":{"ips":{"ens18":"192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64"},"ip":"192.168.1.244","macs":{"ens18":"e4434b217044"}},"cpu_stat":{"cpus":{"cpu1":{"usage":18,"interrupt":0,"idle":81,"user":13,"system":4},"cpu2":{"usage":18,"interrupt":0,"idle":81,"user":13,"system":4},"cpu3":{"usage":97,"interrupt":0,"idle":2,"user":46,"system":50},"cpu0":{"usage":10,"interrupt":0,"idle":89,"user":1,"system":8}},"usage":37,"interrupt":0,"idle":62,"user":19,"system":17},"mxcluster_id":"678bc339-7635-4556-bbc0-e77ad493ef8b","virtualization_type":"KVM","distro":"buster","last_seen":1633721215,"uptime":76281,"service_stat":{"tunterm":{"running_state":"Running","package_state":"Installed","package_version":"0.1.2449+deb10","last_seen":1633721203,"ext_ip":"99.0.86.164","uptime":76261},"mxagent":{"running_state":"Running","package_state":"Installed","package_version":"3.1.1037-1","last_seen":1633721215,"ext_ip":"99.0.86.164","uptime":21240}},"tunterm_stat":{"monitoring_failed":false},"num_tunnels":0,"lag_stat":{"lacp0":{"active_ports":["port0","port1"]}},"port_stat":{"port0":{"up":true,"speed":10000,"full_duplex":true,"tx_bytes":647200748038,"tx_pkts":8788647466,"tx_errors":0,"rx_bytes":646898375700,"rx_pkts":8784449574,"rx_errors":0,"mac":"9e294e49091d","state":"forwarding"},"port1":{"up":true,"speed":10000,"full_duplex":true,"tx_bytes":646898681650,"tx_pkts":8784452092,"tx_errors":0,"rx_bytes":647200437652,"rx_pkts":8788644886,"rx_errors":0,"mac":"a270fe53437e","state":"forwarding"}},"name":"me-vm-1","model":"ME-VM","tunterm_ip_config":{"ip":"192.168.11.91","netmask":"255.255.255.0","gateway":"192.168.11.1"},"tunterm_port_config":{"separate_upstream_downstream":false,"upstream_ports":["0","1"],"downstream_ports":["0","1"]},"services":["tunterm"],"id":"00000000-0000-0000-1000-020000a80cb4","for_site":false,"org_id":"11b08247-b1ee-4152-9b25-312b323ce480","created_time":1632684398,"modified_time":1633643629,"site_id":"00000000-0000-0000-0000-000000000000","mac":"020000a80cb4","mxagent_registered":true,"tunterm_registered":true,"status":"connected"}]