API

Основная задача Collector – принять и сохранить flow с сетевых устройств.

Для включения обработки необходимо через API Collector передать адрес сетевого устройства, отправляющего flow, а также параметр семплирования.

По умолчанию список пар «адрес-семплирование» пуст, в следствие чего Collector не обрабатывает пришедшие flow. Для их обработки необходимо добавить список с помощью RESTful HTTP API, представленного ниже.

Запросы отправляются на порт, указанный в переменной COLLECTOR_API_PORT. По умолчанию 50055.

В качестве параметров запросов выступают:

  • ip – адрес сетевого устройства, которое присылает flow.
  • sample – коэффициент семплирования flow для сетевого устройства. Показывает, сколько пакетов характеризуется данным пакетом. По умолчанию 1.

Получение списка маршрутизаторов

  • Путь: /samples

  • Метод: GET

  • Ответ:

    
    [
      {
        "ip": 3232235521
        "sample": 10
      }
    ]
    

Установка одного маршрутизаторов

  • Путь: /sample

  • Метод: POST

  • Данные:

    [
      {
        "ip": 3232235521
        "sample": 10
      }
    ]
    

Установка списка маршрутизаторов

  • Путь: /samples

  • Метод: POST

  • Данные:

    [
      {
        "ip": 3232235521
        "sample": 10
      },
      {
        "ip": 3232235522
        "sample": 1
      }
    ]
    

Очистка списка маршрутизаторов

  • Путь: /samples
  • Метод: DELETE