Read Node List

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Utility Functions >

Read Node List

Reads the list of all nodes belonging to the virtual server.

 

Request

Method

URL

POST

/smserver-default/sms.ReadNodeList

RAW

POST /smserver-default/sms.ReadNodeList HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{}

]

Explained

Returns a list of all nodes belonging to the current virtual server (the entire node configuration is returned for each node object).

 

Payload: a JSON array containing a single empty object.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

[

       {

           "_id" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

           "Name" : "XE10",

           "Bindings" : [

               {

                   "Active" : true,

                   "Protocol" : "SSH",

                   "IPAddr" : "0.0.0.0",

                   "Port" : 22,

                   "IPVer" : 4,

                   "HostName" : ""

               },

               {

                   "Active" : true,

                   "Protocol" : "FTP",

                   "IPAddr" : "0.0.0.0",

                   "Port" : 21,

                   "IPVer" : 4,

                   "HostName" : ""

               },

               {

                   "Active" : true,

                   "Protocol" : "FTPData",

                   "IPAddr" : "0.0.0.0",

                   "Port" : 20,

                   "IPVer" : 4,

                   "HostName" : ""

               },

               {

                   "Active" : true,

                   "Protocol" : "FTPS",

                   "IPAddr" : "0.0.0.0",

                   "Port" : 990,

                   "IPVer" : 4,

                   "HostName" : ""

               },

               {

                   "Active" : true,

                   "Protocol" : "FTPSData",

                   "IPAddr" : "0.0.0.0",

                   "Port" : 989,

                   "IPVer" : 4,

                   "HostName" : ""

               }

           ],

           "MainSrvTS" : "1899-12-31",

           "LogSrvTS" : "1899-12-31",

           "RESTSrvTS" : "1899-12-31",

           "ProcMem" : 4.01244e+007,

           "SysMem" : NumberLong(8589398016),

           "SysFree" : NumberLong(6647361536),

           "MongoDBHost" : "127.0.0.1",

           "MongoDBPort" : "28038",

           "DeltaSrv" : 82428,

           "DeltaLog" : 82426,

           "DeltaRest" : 9,

           "Status" : "red",

           "StatusArrow" : "down",

           "StatusTip" : "Server seen 82428 sec ago Log server seen 82426 sec ago ",

           "CPUUsage" : 1

       }

   ]

],"id":772674711}

Explained

We receive a JSON array containing all node objects belonging to the current virtual server. Each node object contains the following fields:

 

MainSrvTS: Last time this virtual server's main (SFTP/FTPS) server was alive (heartbeat) - this value is in UTC

LogSrvTS:  Last time this virtual server's main log server was alive (heartbeat) - this value is in UTC

RESTSrvTS: Last time the Web/REST server was alive (heartbeat) - this value is in UTC

ProcMem: The current memory usage for the main (SFTP/FTPS) server process

SysMem: The total amount of memory available to the current machine/VM

SysFree: The amount of free/available memory in the current machine/VM

MongoDBHost: Host name or IP address of the MongoDB server used by the node

MongoDBPort: TCP port of the MongoDB server used by the node

DeltaSrv: seconds past since the last time this virtual server's main (SFTP/FTPS) server was alive

DeltaLog: seconds past since the last time this virtual server's log server was alive

DeltaRest: seconds past since the last time the Web/REST server was alive

Status: A quick way to determine the overall server's status ("red", "yellow", "green")

StatusArrow: quick way of knowing if the server is "up" or "down"

StatusTip: Friendly message carrying information about the overall server status

CPUUsage: Total CPU usage on the machine or VM the virtual server is running on