nodes
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Getting the list of nodes
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: name, fullName, ipAddress, site, server, isSystem, type, dtStart, upTimeSec, status, maxLogLevel, roles. |
|
|
Offset in the list of resources to output. |
|
|
Maximum number of resources in the list. |
|
|
Sorting order of resources in the list. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/master/nodes?offset=38&limit=4 HTTP/1.1
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"dtStart": "2023-03-22T08:06:18Z",
"fullName": "testserv@192.168.0.112",
"ipAddress": "192.168.0.112",
"isSystem": true,
"maxLogLevel": "info",
"name": "testserv",
"server": "testserv",
"site": "main_site",
"status": "active",
"type": "supervisor",
"upTimeSec": 9487
},
{
"dtStart": "2023-03-22T08:07:13Z",
"fullName": "vmail1@192.168.0.112",
"ipAddress": "192.168.0.112",
"maxLogLevel": "info",
"name": "vmail1",
"roles": [
"voicemail"
],
"server": "testserv",
"site": "main_site",
"status": "active",
"type": "role",
"upTimeSec": 9432
},
{
"dtStart": "2023-03-22T08:37:14Z",
"fullName": "ws1@192.168.0.112",
"ipAddress": "192.168.0.112",
"maxLogLevel": "info",
"name": "ws1",
"roles": [
"webserver"
],
"server": "testserv",
"site": "main_site",
"srvIdx": 2525,
"status": "active",
"type": "role",
"upTimeSec": 7631
},
{
"dtStart": "2023-03-22T08:06:41Z",
"fullName": "wssubscr1@192.168.0.112",
"ipAddress": "192.168.0.112",
"maxLogLevel": "info",
"name": "wssubscr1",
"roles": [
"mnesia",
"wssubscr"
],
"server": "testserv",
"site": "main_site",
"status": "active",
"type": "role",
"upTimeSec": 9464
}
]
Getting node data
Request
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/master/node/ws1 HTTP/1.1
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"dtStart": "2023-03-22T08:37:14Z",
"fullName": "ws1@192.168.0.112",
"ipAddress": "192.168.0.112",
"maxLogLevel": "info",
"name": "ws1",
"roles": [
"webserver"
],
"server": "testserv",
"site": "main_site",
"srvIdx": 2525,
"status": "active",
"type": "role",
"upTimeSec": 7631
}
Modifying node properties
Fields prohibited for modification: id
Request
PATCH /rest/v1/master/nodes/ws1 HTTP/1.1
Content-Type: application/json; charset=utf-8
{
"maxLogLevel": "debug"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"dtStart": "2023-03-22T08:37:14Z",
"fullName": "ws1@192.168.0.112",
"ipAddress": "192.168.0.112",
"maxLogLevel": "debug",
"name": "ws1",
"roles": [
"webserver"
],
"server": "testserv",
"site": "main_site",
"srvIdx": 2525,
"status": "active",
"type": "role",
"upTimeSec": 7631
}
Entity fields
| Field | Description |
|---|---|
|
Short node name. Can be used as an identifier. |
|
Full node name. Can be used as an identifier. |
|
Node/server IP address. |
|
Server name from the configuration. |
|
Site to which the server belongs. |
|
Flag indicating whether the node is a system node. |
|
Node type:
* |
|
Maximum configured logging level.
Variants:
* Important! When logging is disabled, some log entries are still placed in the log. The reason is that not every entry is supplied with a level indication. |
|
Node status:
* |
|
Start or last restart time in the UTC time zone. |
|
Uptime. Operating time without restart in seconds. |
|
Node index from the configuration assigned to the microservice (role). |