Получение информации о подключенных Smart Beat
GET /clients
Получить список подключенных Smart Beat к Smart Beat Manager:
curl -k -XGET https://<SBM_HOST>:7769/clients
Получить информацию о конкретном Smart Beat:
curl -k -XGET https://<SBM_HOST>:7769/clients/<guid SB>
Входные параметры Header
| Название | Тип | Описание |
|---|---|---|
| Authorization | string | Логин и пароль в формате Base64 для авторизации Smart Beat Manager |
Выходные параметры
| Название | Тип | Описание |
|---|---|---|
| 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 |
| groups | string array | Массив групп в которой состоит Smart Beat |
| apps | string array | Массив приложений, которые назначаются Smart Beat |
| errors | object | Структура с ошибками |
Структура errors представлена в следующем виде:
| Название | Тип | Описание |
|---|---|---|
| status | bool | Статус присутствия ошибки |
| guid | string | Уникальный идентификатор Smart Beat |
| errortimestamp | string | Время отправки ошибки |
| errors | object array | Массив объектов с ошибками |
В массиве errors объекты представлены в следующем виде:
| Название | Тип | Описание |
|---|---|---|
| app | string | Название ресурса с которым возникли ошибки |
| apperrors | string array | Содержание ошибок |
Поддерживаемые ошибки
| Статус | Содержание ошибки | Описание ошибки |
|---|---|---|
| 400 | Non connected clients yet | Подключенных Smart Beat еще нет |
| 500 | <ошибка записи ответа на запрос> | Внутренняя ошибка сервера |
Примеры
Пример выходных параметров запроса /clients:
[
{
"ip": "133.133.133.132",
"hostname": "coolHost",
"dns": "google",
"guid": "1231",
"system": "windows-amd64",
"timestamp": "2020-10-21 19:14:07",
"groups": [
"android",
"windows",
],
"apps": [
"examplebeat_1"
] ,
"errors": {
"status": false,
"errors": null,
"errortimestamp": ""
}
},
{
"ip": "133.133.133.133",
"hostname": "coolHost",
"dns": "google",
"guid": "1232",
"system": "windows-amd64",
"timestamp": "2020-10-21 19:14:55",
"groups": [
"linux",
"ios"
],
"apps": [
"filebeat_1"
],
"errors": {
"status": true,
"errors": [
{
"app": "filebeat",
"apperrors": [
"error1",
"error2"
]
},
{
"app": "examplebeat",
"apperrors": [
"error3",
"error4"
]
}
],
"errortimestamp": "2020-11-09 17:05:30"
}
}
]
Пример выходных параметров запроса /clients/1231:
{
"ip": "133.133.133.132",
"hostname": "coolHost",
"dns": "google",
"guid": "1231",
"system": "windows-amd64",
"timestamp": "2020-10-21 19:14:07",
"groups": [
"android",
"windows",
],
"apps": [
"examplebeat_1"
],
"errors": {
"status": false,
"errors": null,
"errortimestamp": ""
}
}