Kraken - API

Содержание
  1. Порт подключения к API
  2. Авторизация API
  3. Коды ответов API
  4. Команды API
  5. Плейбуки
  6. Проверка состояния
  7. Отправка событий (messages)
  8. Профили (messages)
  9. Отправка одиночных событий (sender)
  10. Работа с шаблонами
  11. Проверка версии

Порт подключения к API

По умолчанию по умолчанию 6015/TCP можно изменить в интерфейсе.

После изменения, необходимо переподключить API

Авторизация API

для авторизации используется заголовок: X-API-KEY

API принимает заголовок X-API-KEY в виде GET параметра, либо как кастомный заголовок.

Пример:

http://127.0.0.1:6015/play/CCD142CE-0AB5-4492-A9F7-762019803C96?X-API-KEY=15A692A4-DDEC-4DE4-8DE9-2131062CF36B

Коды ответов API

Код Описание
200 Доступен
201 Задача запущена
400 Ошибка в запросе
401 Требуется авторизация
404 Элемент задачи не найден
405 Метод не поддерживается
423 Целевой ресурс из запроса заблокирован от применения к нему указанного метода
500 Ошибка сервера
503 Команда не доступна

Команды API

Плейбуки

Команда Параметры Дополнительные параметры Описание
play ID Плейбука Запустить Плейбук по ID
[GET] http://127.0.0.1:6015/play/CCD142CE-0AB5-4492-A9F7-762019803C96
playbook list Возвращает список плейбуков, в формате имя=id

[GET] http://127.0.0.1:6015/playbook/list

Проверка состояния

Команда Параметры Дополнительные параметры Описание
state live Проверить доступность API.

[GET] http://127.0.0.1:6015/state/live

Отправка событий (messages)

Команда Параметры Дополнительные параметры Описание
messages start EPS - установить значение EPS для задачи отправки.

stoptime - Установить время выполнения задачи отправки.

StopCount - Установить количество отправляемых событий, до остановки.

 Запустить отправку событий с текущим профилем.

[GET] http://127.0.0.1:6015/messages/start

[GET] http://127.0.0.1:6015/messages/start?EPS=1000&stoptime=3600

[GET] http://127.0.0.1:6015/messages/start?EPS=1000

[GET] http://127.0.0.1:6015/messages/start?EPS=1000&stoptime=360&StopCount=100000
messages stop Остановить отправку событий

[GET] http://127.0.0.1:6015/messages/stop
messages eps Вернуть текущий EPS

[GET] http://127.0.0.1:6015/messages/eps
messages avg Вернуть текущий средний EPS

[GET] http://127.0.0.1:6015/messages/avg
messages state Вернуть статус отправки (Активен/Не активен)

[GET] http://127.0.0.1:6015/messages/state
messages time Получить время работы (отправки) в секундах

[GET] http://127.0.0.1:6015/messages/time
messages sent Получить количество отправленных событий

[GET] http://127.0.0.1:6015/messages/sent
messages set eps - установить значение EPS для задачи отправки.
stoptime - Установить время выполнения задачи отправки.
stopcount - Установить количество отправляемых событий, до остановки.
timeout - Установить таймаут между отправкой событий
randomtimeout - использовать случайный тамаут (true/false)		 Позволяет изменить параметры отправки событий в messages, не выполняя каких либо действий.

[GET] http://127.0.0.1:6015/messages/set?eps=100&stoptime=5&stopcount=1000

[GET] http://127.0.0.1:6015/messages/set?timeou=1&randomtimeou=true
messages clear Полностью очищает список правил отправки событий в Messages

[GET] http://127.0.0.1:6015/messages/clear
messages disable Отключает все правила отправки, не удаляя их

[GET] http://127.0.0.1:6015/messages/disable
messages add proto - указать протокол отправки
port - указать порт отправки
host - указать хост отправки
template - указать имя шаблона
json - включить или выключить json формат (true/false)		 Добовляет новое правило отправки событий

Если шаблона не существует, запись не будет добавлена

[GET] http://127.0.0.1:6015/messages/add?template=nginx&port=1234&proto=TCP&host=123.123.123.123

Профили (messages)

Команда Параметры Дополнительные параметры Описание
profiles save name - имя профиля (обаятельное поле) Сохранить текущий профиль messages

[GET] http://127.0.0.1:6015/profiles/save?name=test
profiles load name - имя профиля (обаятельное поле) Загрузить профиль messages

[GET] http://127.0.0.1:6015/profiles/load?name=test
profiles list Получить список доступных профилей
profiles delete name - имя профиля (обаятельное поле) Удалить сохраненный профиль

[GET] http://127.0.0.1:6015/profiles/delete?name=test

Отправка одиночных событий (sender)

Команда Параметры Дополнительные параметры Описание
sender start message - Сообщение для отправки (обязательный параметр)
host - Установить хост
port - Установить порт
proto - Выбрать протокол (из списка достпуных)
index - Установить параметр Index
json - установить параметр отправки событий в формте json (true/false)		 [GET] http://127.0.0.1:6015/sender?message=<message>&proto=udp&index=test2&json=false

Работа с шаблонами

Команда Параметры Дополнительные параметры Описание
templates list Получить список доступных шаблонов

[GET]http://127.0.0.1:6015/templates/list
templates add Обязательные параметры:
name - имя шаблона
message - событие для добавление в шаблонНе обязательные параметры:
index - установить индекс в шаблоне		 Добавить событие в шаблон

[GET]http://127.0.0.1:6015/templates/add?name=Test&message=1

Проверка версии

Команда Параметры Дополнительные параметры Описание
version build Вернуть номер сборки
[GET] http://127.0.0.1:6015/vesion/build
version app Получить версию приложения

[GET] http://127.0.0.1:6015/vesion/app
Поделиться с друзьями