NiFi REST API

Ольга Семме

REST API обеспечивает программный доступ для управления экземпляром NiFi в режиме реального времени.

REST API позволяет при помощи REST-запросов без использования пользовательского интерфеса NiFi выполнять различные операции, например:

Ниже приведено описание групп API, представленных в NiFi.

Группа API Назначение

Access User

Конечные точки аутентификации и токенов

Connections

Управление и получение конфигурации соединений, например:

  • установка приоритета очереди;

  • обновление назначения подключения.

Controller

Управление конфигурацией контроллера, например:

  • вывод текущей конфигурации;

  • управление кластером;

  • создание задач отчетности.

Controller Services

Управление сервисами контроллера, обновление ссылок на сервисы контроллера

Counters

Управление счетчиками событий:

  • получение счетчиков событий;

  • сброс счетчиков событий.

Data Transfer

Управление транзакциями, например:

  • управление сроком жизни транзакции;

  • отмена указанной транзакции;

  • отправка данных;

  • получение данных.

Flow

Управление конфигурацией потока, например:

  • получение данных о потоке (например, список созданных бюллетеней);

  • получение данных о статусе компонентов потока;

  • получение истории запросов.

FlowFile Queues

Управление и получение конфигураций очереди потока данных, например:

  • просмотр содержимого очереди;

  • загрузка содержимого потокового файла;

  • очищение очереди.

Funnels

Управление "воронками"

Input Ports

Управление и получение конфигураций входных портов, например:

  • создание входного порта;

  • установка контроля удаленного доступа к порту.

Labels

Управление метками, например:

  • создание метки;

  • установка стиля метки.

Output Ports

Управление и получение конфигураций выходных портов, например:

  • создание выходного порта;

  • установка контроля удаленного доступа к порту.

Parameter Contexts

Создание, удаление, управление и получение конфигураций контекстов параметров

Parameter Providers

Управление и получение конфигураций поставщиков параметров

Process Groups

Управление и получение конфигураций группы процессов, например:

  • создание компонентов;

  • создание экземпляра шаблона;

  • загрузка шаблона.

Processors

Управление и получение конфигураций процессоров, например:

  • создание и удаление процессоров;

  • установка свойств процессора, в том числе установка расписания работы процессора.

Policies

Управление и получение данных о политиках доступа

Provenance

Управление происхождением данных (provenance):

  • запрос о происхождении;

  • поиск происхождения данных.

Provenance Events

Управление происхождением событий:

  • загрузка содержимого события;

  • повтор запуска содержимого из события заданного происхождения.

Remote Process Groups

Управление и получение конфигураций удаленных групп, например:

  • создание удаленной группы;

  • включение передачи данных.

Reporting Tasks

Управление задачами отчетности

Resources

Получение доступных ресурсов, поддерживающих политики доступа/авторизации

Site to Site

Получение данных для связи "site to site":

  • получение сведений об экземпляре NiFi, необходимых для связи (доступные порты);

  • получение сведений о доступных участниках одноранговой сети и статусе их NiFi-экземпляра.

Snippets

Управление фрагментами схемы:

  • перемещение фрагмента;

  • удаление фрагмента.

System Diagnostics

Получение диагностики системы

Templates

Управление шаблонами, например:

  • загрузка шаблона;

  • удаление шаблона.

Tenants

Управление группами пользователей (арендаторами):

  • добавление пользователей;

  • создание групп пользователей.

Versions

Управление версиями групп процессов
ПРИМЕЧАНИЕ

Полный список Rest API, доступных в NiFi, с указанием запросов и конечных точек приведен в статье /nifi-api.
Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней