...
Управление узлами осуществляется при помощи помощи Websocket API или REST API
Создание узла
Новый узел создается автоматически при подключении к бэкенд-серверу нового узла, которого нет в БД.
...
Параметры узла могут быть изменены при помощи REST API запроса /api/node/update
...
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 |
Здесь:
- id – идентификатор узла
- profiles – список идентификаторов профилей, определяющих метрики, собираемые с данного сервера
...
Узел может быть удален при помощи REST API запроса /api/node/delete
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 |
Здесь:
- id – идентификатор узла
...
Информацию об узле можно получить при помощи REST API запроса /api/node/list
...
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
...
|
...
|
...
|
...
|
...
Здесь:
- id – идентификатор узла
Если указан идентификатор узла, то ответ будет содержать информацию только об этом узле. Если идентификатор не указан, ответ будет содержать информацию обо всех узлах на бэкенд-сервере.
Ответ на запрос информации об узле выглядит следующим образом
...
language | js |
---|---|
theme | RDark |
...
| 200 OK 404 Object not found 500 Persist exception | |||||||||||
REST API |
|
|
...
|
...
|
...
|
...
| 200 OK 404 Object not found 500 Persist exception |
Здесь:
- id – идентификатор узла
- host - адрес WCS-сервера, подключенного к бэкенду
- profiles - список профилей
Если указан идентификатор узла, то ответ будет содержать информацию только об этом узле. Если идентификатор не указан, ответ будет содержать информацию обо всех узлах на бэкенд-сервере.
Получение текущего состояния узла
Текущее состояние узла можно получить при помощи REST API запроса /api/node_status/
...
list
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
...
|
...
|
...
|
...
|
...
Здесь:
- id – идентификатор узла
Если указан идентификатор узла, то ответ будет содержать информацию только об этом узле. Если идентификатор не указан, ответ будет содержать текущее состояние всех узлов, наблюдаемых на бэкенде.
Ответ содержит следующие поля
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": 15,
"connectTimestamp": 1545645928951,
"connectCounter": 1,
"connected": true,
"rate": 0
}
] |
Здесь
...
|
| 200 OK 404 Object not found 500 Persist exception | |||||||||||
REST API |
|
| 200 OK 404 Object not found 500 Persist exception |
Здесь:
- id – идентификатор узла
- rate – частота, с которой метрики присылаются WCS-сервером на бэкенд-сервер
Если указан идентификатор узла, то ответ будет содержать информацию только об этом узле. Если идентификатор не указан, ответ будет содержать текущее состояние всех узлов, наблюдаемых на бэкенде.
Если узел в данный момент не подключен к бэкенд-серверу, либо такой узел никогда ранее не подключался, запрос вернет ошибку 404 OBJECT_NOT_FOUND