Apache NiFi - API

NiFi propose un grand nombre d'API, qui aide les développeurs à apporter des modifications et à obtenir des informations sur NiFi à partir de tout autre outil ou applications développées sur mesure. Dans ce tutoriel, nous utiliserons l'application Postman dans Google Chrome pour expliquer quelques exemples.

Pour ajouter postmantoyour Google Chrome, accédez à l'URL mentionnée ci-dessous et cliquez sur le bouton Ajouter au chrome. Vous verrez maintenant une nouvelle application ajoutée à votre Google Chrome.

boutique en ligne chrome

La version actuelle de l'API NiFi rest est la 1.8.0 et la documentation est présente dans l'URL mentionnée ci-dessous.

https://nifi.apache.org/docs/nifi-docs/rest-api/index.html

Voici les modules d'API NiFi rest les plus utilisés -

  • http: // <url nifi>: <port nifi> / nifi-api / <api-path>

  • Si HTTPS est activé https: // <nifi url>: <nifi port> / nifi-api / <api-path>

S.No. Nom du module API api-path La description
1 Accès /accès Pour authentifier l'utilisateur et obtenir un jeton d'accès de NiFi.
2 Manette /manette Pour gérer le cluster et créer une tâche de rapport.
3 Services de contrôleur / controller-services Il est utilisé pour gérer les services du contrôleur et mettre à jour les références de service du contrôleur.
4 Tâches de rapport / reporting-tâches Pour gérer les tâches de reporting.
5 Couler /couler Pour obtenir les métadonnées du flux de données, l'état des composants et l'historique des requêtes
6 Groupes de processus / process-groups Pour télécharger et instancier un modèle et créer des composants.
sept Processeurs / processeurs Pour créer et planifier un processeur et définir ses propriétés.
8 Connexions /Connexions Pour créer une connexion, définir la priorité de la file d'attente et mettre à jour la destination de la connexion
9 Files d'attente FlowFile / flowfile-queues Pour afficher le contenu de la file d'attente, téléchargez le contenu du fichier de flux et videz la file d'attente.
dix Groupes de processus distants / remote-process-groups Pour créer un groupe distant et activer la transmission.
11 Provenance /provenance Pour interroger la provenance et rechercher le lignage des événements.

Considérons maintenant un exemple et exécutons sur postman pour obtenir les détails sur l'instance NiFi en cours d'exécution.

Demande

GET http://localhost:8080/nifi-api/flow/about

Réponse

{
   "about": {
      "title": "NiFi",
      "version": "1.7.1",
      "uri": "http://localhost:8080/nifi-api/",
      "contentViewerUrl": "../nifi-content-viewer/",
      "timezone": "SGT",
      "buildTag": "nifi-1.7.1-RC1",
      "buildTimestamp": "07/12/2018 12:54:43 SGT"
   }
}