Konfigurieren Sie die API-Kontrollebene, um einen Kommunikationskanal zwischen webMethods API Gateway und der API-Kontrollebene zum Austausch von Daten.
Wenn Sie den API Control Plane Agent über die webMethods API Gateway UI konfigurieren, stellen Sie sicher, dass Sie die folgenden Punkte beachtet haben.
- Sie verwenden webMethods API Gateway version 10.15.0 Fix 11 oder höher.
- Sie verfügen über die Funktionsberechtigung Zielkonfigurationen verwalten, um diese Aufgabe auszuführen.
- Sie haben den erforderlichen API-Schlüssel. Weitere Informationen zum Generieren eines API-Schlüssels finden Sie unter API-Schlüssel generieren.
Informationen zu dieser Task
API Control Plane ist ein zentralisiertes System zur Steuerung und Überwachung. Sie überwacht und verwaltet die gesamte API-Verwaltungslandschaft, die in mehreren Regionen eingesetzt wird, einschließlich Cloud- und On-Premises-Umgebungen. Die Verbindung von webMethods API Gateway zur API Control Plane ermöglicht die Kontrolle und Verwaltung der Leistung von webMethods API Gateway effektiv über die API Control Plane.
Um eine Verbindung webMethods API Gateway mit der API Control Plane zu verbinden, muss der API Control Plane Agent in webMethods API Gateway um einen Kommunikationskanal mit der API Control Plane einzurichten. Der Agent ist für den Aufbau und die Aufrechterhaltung der Kommunikation mit der API Control Plane verantwortlich.
- Öffnen Sie die Menüoptionen und wählen Sie Verwaltung.
- Ziele auswählen.
- Wählen Sie , um den API Control Plane-Agenten zu konfigurieren.
- Geben Sie die folgenden Informationen im Abschnitt webMethods API Gateway Grundlegende Informationen an:
- Geben Sie die folgenden Informationen in den Abschnitt webMethods API Gateway ein.
- Art des Einsatzes. webMethods API Gateway einsatzart. Der Standardwert ist IBM Cloud. Dieses Feld kann nicht bearbeitet werden.
- Region. Optional. Name der Region, in der webMethods API Gateway eingesetzt wird.
- Standort. Optional. Name des Landes, in dem webMethods API Gateway eingesetzt wird.
- Gastgeber. Optional. Basis URL von webMethods API Gateway in dem Format, http://hostname oder https://hostname.
- Kapazität. Optional. Die ungefähre Schätzung des Durchsatzes, der webMethods API Gateway für die angegebene Dauer bewältigen kann. Sie können den Kapazitätswert mit einer beliebigen nichtnegativen ganzen Zahl konfigurieren.
- Kapazität Einheiten. Optional. Wählen Sie die Zeiteinheit, in der die Kapazität definiert werden soll. Mögliche Werte sind wie folgt
- pro Sekunde
- Pro Minute
- pro Stunde
- pro Tag
- pro Woche
- pro Monat
- pro Jahr
- Geben Sie im Abschnitt zur Konfiguration der API-Kontrollebene die folgenden Informationen an:
- API-Kontrollebene URL. Basis URL von API Control Plane. Beispiel http://hostname oder https://hostname.
- Authentifizierungstyp : Wählen Sie einen Authentifizierungstyp für die angegebene Control Plane URL.
Hinweis: Wenn sich Ihre Zielinstanz der API-Kontrollebene in IBM SaaS Console befindet, müssen Sie den Authentifizierungstyp MCSP API Key verwenden. Wenn sich das Ziel nicht in der IBM SaaS Konsole befindet, müssen Sie die einfache Authentifizierung verwenden.
- Grundlegende Anmeldung : Sie müssen einen Benutzernamen und ein Passwort angeben.
- MCSP (Managed Cloud Service Provider) API-Schlüssel : Sie müssen einen API-Schlüssel und eine Instanz-ID angeben.
- API-Schlüssel. Geben Sie den API-Schlüssel der angegebenen Instanz der API-Kontrollebene an. Weitere Informationen zur Generierung eines API-Schlüssels finden Sie unter Generierung eines API-Schlüssels.
Hinweis: Die Service-ID muss die Benutzerrolle Service-Benutzer oder Service-Eigentümer haben.
- Instanz-ID : Suchen Sie auf der Seite IBM SaaS Console Subscriptions das Abonnement, dem Sie einen API-Schlüssel hinzufügen möchten, und klicken Sie auf View instances. Wählen Sie eine Instanz für die angegebene API-Kontrollebene aus. Wählen Sie die Registerkarte Instanzdetails und kopieren Sie die Instanz-ID.
Hinweis: Verwenden Sie die automatisch ausgefüllte Instanz-ID, wenn Sie sich mit der gleichen Instanz verbinden.
- Geben Sie die folgenden Informationen im Abschnitt zur Synchronisierungskonfiguration an, um die Daten von webMethods API Gateway mit der API Control Plane zu synchronisieren:
- Intervall für die Synchronisierung von Metriken (in Sekunden). Die Dauer in Sekunden, in der ein webMethods API Gateway seine Metrikdaten an die API-Kontrollebene senden muss. Standardwert 120.
- Asset-Synchronisierungsintervall (in Sekunden). Die Dauer in Sekunden, in der webMethods API Gateway die Änderungen, die an den Assets vorgenommen werden, mit der API-Kontrollebene synchronisieren muss. Standardwert 180.
- Maximale Wiederholungsversuche. Die maximale Anzahl von Wiederholungsversuchen, die für webMethods API Gateway um eine Verbindung mit der API-Kontrollebene herzustellen, wenn diese verloren geht. Standardwert 5.
- Wiederholungszeitintervall (in Sekunden). Die Dauer in Sekunden, in der die webMethods API Gateway die Verbindung mit der API-Kontrollebene wiederherstellen muss, wenn sie unterbrochen wurde. Standardwert 60.
- Klicken Sie auf Test, um die Verbindung zwischen webMethods API Gateway und der API-Kontrollebene zu testen. Die Verbindung mit der API Control Plane wird getestet und eine Erfolgsmeldung erscheint.
- Aktivieren Sie die Umschalttaste für die API Control Plane-Kommunikation, um die Kommunikation zwischen webMethods API Gateway und der API Control Plane herzustellen.
- Klicken Sie auf Speichern. Die Agentenkonfiguration wird in Elasticsearch gespeichert, und es wird eine Kommunikation zwischen webMethods API Gateway und der API-Kontrollebene hergestellt.
Hinweis: Notieren Sie sich die folgenden Punkte, bevor Sie die folgenden Konfigurationen neu konfigurieren und speichern.
- Durch die Änderung des Feldes Laufzeitname wird ein neuer Kommunikationskanal eingerichtet und eine neue Laufzeit in der API-Kontrollebene erstellt. Der Status der alten Laufzeitumgebung wird rot, was bedeutet, dass die Verbindung unterbrochen ist.
- Die Änderung eines beliebigen Feldes mit Ausnahme des Laufzeitnamens stoppt den bestehenden Kommunikationskanal und baut ihn mit den aktualisierten Werten neu auf. Während dieser Zeit wird der Status der Laufzeitumgebung rot angezeigt, was bedeutet, dass die Verbindung unterbrochen ist.
- Wenn die Verbindung unterbrochen wird, wechselt die Kommunikationsschaltfläche der API-Kontrollebene in einen deaktivierten Zustand, was anzeigt, dass die Verbindung unterbrochen ist.
Nächste Schritte
Sie können die Konfiguration der API Control Plane-Agenten auch mithilfe von REST-APIs verwalten. Weitere Einzelheiten finden Sie unter API Gateway Verwaltung.