API позволяется удаленно управлять Kraken Stress Testing Toolkit, а так же получать информацию (статистику) по текущей работе.
Содержание
Порт подключения к API
По умолчанию по умолчанию 6015/HTTP, можно изменить в интерфейсе.
После изменения, необходимо переподключить 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
Получение текущей статистики потока messages
Метод позволяет получить текущую статистику по потоку событий.
- Messages - текущее состояние отправки событий.
- true - Активно
- false - Остановлено
- EPS - текущее количество событий в секунду.
- AVG - Среднее количество отправляемых событий в секунду.
- Sending - Количество отправленных событий с момента запуска.
- Time - Время с момента запуска, в секундах.
Запрос
[GET] http://127.0.0.1:6015/v2/statistics
Пример ответа
{
"Messages": true
"EPS": 19075,
"AVG": 27032.0,
"Sending": 162192,
"Time": 6
}