Получение информации о текущих группах
GET /serverclasses
Получить список доступных групп на Smart Beat Manager:
curl -k -XGET https://<SBM_HOST>:7769/serverclasses
Входные параметры Header
| Название | Тип | Описание |
|---|---|---|
| Authorization | string | Логин и пароль в формате base64 для авторизации Smart Beat Manager |
Выходные параметры
Массив объектов в формате JSON.
Каждый объект состоит из следующих параметров:
| Название | Тип | Описание |
|---|---|---|
| name | string | Название группы |
| filters | string array | Список фильтров (данные о том какие Smart Beat входят в эту группу) |
| systems | string array | Список операционных систем для которых предназначена данная группа |
| connectedclients | string | Количество подключенных к данной группе Smart Beat |
Поддерживаемые ошибки
{
"name": "linux",
"filters": [
"137.12.23.9",
"146.34.32.1",
"133.133.133.130"
],
"apps": [
"filebeat",
"scriptbeat"
],
"systems": [
"linux"
],
"connectedclients": 5
}
GET /serverclasses/<название группы>
Получить более подробную информацию по конкретной группе:
curl -k -XGET https://<SBM_HOST>:7769/serverclasses/<название группы>
Входные параметры Header
| Название | Тип | Описание |
|---|---|---|
| Authorization | string | Логин и пароль в формате Base64 для авторизации Smart Beat Manager |
Выходные параметры
Массив объектов в формате JSON.
Каждый объект состоит из следующих параметров:
| Название | Тип | Описание |
|---|---|---|
| name | string | Название группы |
| filters | string array | Список фильтров (данные о том какие Smart Beat входят в эту группу) |
| systems | string array | Список операционных систем для которых предназначена данная группа |
| connectedclients | object array | Количество подключенных к данной группе Smart Beat |
В массиве connectedclients объекты представлены в следующем виде:
| Название | Тип | Описание |
|---|---|---|
| ip | string | IP-адрес Smart Beat |
| dns | string | DNS Smart Beat |
| hostname | string | Hostname Smart Beat |
| system | string | Операционная система Smart Beat |
| guid | string | Уникальный идентификатор Smart Beat |
| timestamp | string | Время последнего подключения Smart Beat |
Поддерживаемые ошибки
| Статус | Содержание ошибки | Описание ошибки |
|---|---|---|
| 500 | <ошибка записи ответа на запрос> | Внутренняя ошибка сервера |
| 400 | Group not exist | Группы с названием, переданным в URL, не существует |
Примеры
Пример выходных параметров:
{
"name": "137",
"filters": [
"172.17.0.137"
],
"apps": [
"filebeat_1"
],
"systems": ["windows"],
"connectedclients": [
{
"ip": "172.17.0.137",
"hostname": "Test-Windows",
"dns": "Test-WINDOWS",
"guid": "4a8cd520-8218-4614-a810-a4bd5da307ce",
"system": "windows",
"timestamp": "2020-01-01 00:00:35"
}
]
}