...
Nodes can be managed using Websocket API or REST API.
Node creation
New node is created automatically when WCS server, which is not in the database, connects to backend server.
...
Node parameters can be changed with REST API query /api/node/update
...
request
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
...
|
...
|
...
|
| 200 OK 404 Object not found 500 Persist exception | ||||||
REST API |
|
...
|
| 200 OK 404 Object not found 500 Persist exception |
Where
- id – node identifier
- profiles – list of identifiers of profiles defining which metrics are acquired from this node
...
A node can be deleted with REST API query /api/node/delete request
API | Request | Response | Response status |
---|---|---|---|
WS API |
|
...
|
|
...
|
...
| 200 OK 404 Object not found 500 Persist exception | |||||
REST API |
|
...
|
...
|
| 200 OK 404 Object not found 500 Persist exception |
Where
- id – node identifier
...
Obtaining node information
Node A node information can be obtained with REST API query /api/node/list
...
request
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
...
|
...
|
...
|
|
Where
- id – node identifier
If node Id is set, the response will contain only that node information. If Id is not set, the response will contain list with all the nodes on backend server.
The response contains the following fields
...
language | js |
---|---|
theme | RDark |
...
| 200 OK 404 Object not found 500 Persist exception | |||||||||||
REST API |
|
|
...
|
...
|
...
|
...
| 200 OK 404 Object not found 500 Persist exception |
Where
- id – node – node identifier
- host - WCS server address
- profiles - profiles list
If node Id is set, the response will contain only that node information. If Id is not set, the response will contain list with all the nodes on backend server.
Obtaining node current state
Node A node current state can be obtained with REST API query /api/node_status/list
...
query
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
...
|
...
|
...
|
...
|
|
Where
- id – node identifier
If node Id is set, the response will contain only that node state. If Id is not set, the response will contain current state of all the nodes on backend server.
The response contains the following fields
...
language | js |
---|---|
theme | RDark |
...
| 200 OK 404 Object not found 500 Persist exception | ||||||||||||
REST API |
|
| 200 OK 404 Object not found 500 Persist exception |
Where
- id – node identifier
- connectTimeStamp – current connection timestamp
- connectCounter – current connection attempts count
- connected – if the connection is established
- rate – metrics acquisition raterate – metrics acquisition rate
If node Id is set, the response will contain only that node state. If Id is not set, the response will contain current state of all the nodes on backend server.
If the node is not connected to backend server, or if this node never be connected, the response will be 404 OBJECT_NOT_FOUND