Ressourcen mit der REST-Verwaltungs-API verwalten

IBM® App Connect Enterprise unterstützt die REST-API (Representational State Transfer Application Programming Interface), über die Sie Integrationsknoten, Integrationsserver und andere Ressourcen verwalten können.

Informationen zu dieser Task

IBM App Connect Enterprise unterstützt die REST-API auf den Plattformen Linux®, AIX® und Windows.

Die REST-API-Klassen und -Methoden sind in der Spezifikation App Connect Enterprise REST API V2 beschrieben, die Sie in einem Browser anzeigen können, indem Sie die Adresse Ihres Integrationsknotens oder Integrationsservers und den Verwaltungs-REST-API-Port gefolgt von /apidocsangeben. Um beispielsweise die REST-API-Spezifikation für einen Integrationsknoten anzuzeigen, geben Sie eine URL wie die im folgenden Beispiel gezeigte ein (unter Verwendung von http oder https):
https://localhost:4414/apidocs
Dabei steht localhost für die Adresse des Integrationsknotens und 4414 für den Port der REST-Verwaltungs-API, der in der Datei node.conf.yaml angegeben ist.
Zur Anzeige der REST-API-Spezifikation für einen Integrationsserver geben Sie eine URL wie die im folgenden Beispiel gezeigte ein (unter Verwendung von http oder https):
https://green.company.com:7600/apidocs
Dabei ist green.company.com die Adresse des Integrationsservers und 7600 der in der Datei server.conf.yaml angegebene Port der REST-Verwaltungs-API.
Details zur REST-API finden Sie auch unter REST-API für die Verwaltung von Integrationsknoten und Integrationsservern . Dabei gilt Folgendes:
  • openapi-appconnectenterprise.yaml definiert die Details der REST-API für die Verwaltung von Integrationsknoten.
  • openapi-appconnectenterpriseserver.yaml definiert die Details der REST-API für die Verwaltung von Integrationsservern.
Die REST-API-Dokumentation wird auch mit Ihrer Installation von App Connect Enterprisein den folgenden Verzeichnissen bereitgestellt:
  • install_dir\server\nodejs\node_modules\@ibm-app-connect\ace-admin-api\docs\server
  • install_dir\server\nodejs\node_modules\@ibm-app-connect\ace-admin-api\docs\node
Dabei ist installationsverzeichnis das Verzeichnis, in dem App Connect Enterprise installiert ist.
Weitere Informationen zur Verwendung der REST-Verwaltungs-API finden Sie in den folgenden Themen: