Weitere Informationen finden Sie unter Unterstützte Connectors für Application Integration.

Benutzerdefinierten Connector erstellen

Vorschau

Dieses Produkt oder diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Produkte und -Funktionen sind unverändert verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Auf dieser Seite wird beschrieben, wie Sie einen benutzerdefinierten Connector erstellen. Informationen zu benutzerdefinierten Connectors finden Sie unter Benutzerdefinierte Connectors.

Hinweis: Ein benutzerdefinierter Connector ist eine globale Ressource. Das bedeutet, dass Sie ihn nach der Erstellung an allen für die Anwendungsintegration unterstützten Standorten verwenden können.

Wenn Sie eine Verbindung zu Ihrem Back-End über einen benutzerdefinierten Connector herstellen möchten, müssen Sie die folgenden Aufgaben ausführen:

1. Benutzerdefinierten Connector erstellen: In dieser Aufgabe definieren Sie den Vertrag. zwischen Application Integration und Ihrem Endpunkt (Back-End), indem Sie die OpenAPI-Spezifikation des Endpunkts angeben. Derzeit werden nur OpenAPI Version 3.0 und alle zugehörigen Nebenversionen unterstützt. Die Spezifikation muss nur einmal angegeben werden.
2. Benutzerdefinierte Connector-Verbindung erstellen: In dieser Aufgabe konfigurieren Sie Ihres Back-End, wie den Hostnamen und die Authentifizierung. Für einen bestimmten benutzerdefinierten Connector können Sie beliebig viele Verbindungen erstellen.

Weitere Informationen zum Unterschied zwischen einem Connector und einer Verbindung finden Sie unter Connector und Verbindung im Vergleich.

Hinweis

• Um die Berechtigungen zu erhalten, die Sie zum Erstellen des benutzerdefinierten Connectors benötigen, bitten Sie Ihren Administrator, Ihnen IAM-Rolle Custom Connectors Admin (roles/connectors.customConnectorAdmin) für das Projekt. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

  Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

• Aktivieren Sie die Connector API:
  Connector API aktivieren

Benutzerdefinierten Connector erstellen

Wie in den Szenarien für die Backend-Konnektivität beschrieben, können benutzerdefinierte Connectors eines der folgenden Konnektivitätsmuster haben:

• Direkte Verbindung zum öffentlichen Endpunkt Ihres Back-Ends.
• Indirekte Verbindung zu Ihrem Backend über einen vermittelnden öffentlichen Endpunkt.

Die Schritte zum Erstellen eines benutzerdefinierten Connectors variieren für diese beiden Muster geringfügig.

Mit direkter Verbindung erstellen

So erstellen Sie einen benutzerdefinierten Connector mit direkter Verbindung zum Endpunkt Ihres Back-Ends: führen Sie die folgenden Schritte aus:

Console

1. Gehen Sie in der Console zu Seite Application Integration > Custom Connectors aus, Wählen Sie dann ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Zur Seite „Benutzerdefinierte Connectors“

2. Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
3. Legen Sie im Abschnitt Anschlussdetails die folgenden Felder fest:
   1. Name des Connectors: Geben Sie einen Namen für den Connector ein.
   2. Anzeigename: Geben Sie einen Anzeigenamen für den Connector ein.
   3. Beschreibung: Geben Sie eine Beschreibung ein.
   4. Dienstkonto: Wählen Sie ein Dienstkonto aus, das über die erforderlichen Rollen verfügt.
   5. Logo: Laden Sie das Bild in einen Cloud Storage-Bucket hoch, um es als Verbindungslogo zu verwenden.
      Hinweis: Achten Sie darauf, dass die Verhinderung des öffentlichen Zugriffs für Ihren Cloud Storage-Bucket deaktiviert ist.
4. Klicken Sie auf Weiter.
5. Legen Sie im Abschnitt Connector-Spezifikation die folgenden Felder fest:
   1. Benutzerdefinierter Anschlusstyp: Wählen Sie den benutzerdefinierten Anschlusstyp aus.
   2. Connector-Spezifikation: Geben Sie entweder die öffentliche URL Ihrer Open API-Spezifikation ein oder laden Sie die Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
6. Prüfen Sie die Details der Connector-Konfiguration und klicken Sie dann auf Erstellen.

Wenn der Connector erfolgreich erstellt wurde, wird der neu erstellte Connector im Rufen Sie die Seite „Benutzerdefinierte Connectors“ auf. Wenn es sich um einen neuen Connector handelt, sehen Sie eine erste Version des wird der Connector ebenfalls erstellt. Sie finden die Versionsdetails auf der Seite Details zum benutzerdefinierten Connector auf dem Tab Version. Weitere Informationen finden Sie unter , um die Stoppuhr auf null zu setzen.

Beachten Sie jedoch, dass Sie für die Verbindung zu Ihrem Backend eine Verbindung für den neu erstellten Connector erstellen müssen. Weitere Informationen finden Sie unter Benutzerdefinierte Connector-Verbindung erstellen.

API

Die folgenden Beispielbefehle zeigen, wie Sie mithilfe der APIs zur Anwendungsintegration einen benutzerdefinierten Connector erstellen:

1. Erstellen Sie den Connector.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -d '{"customConnectorType":"OPEN_API", \
   "displayName":"CUSTOM_CONNECTOR_NAME", \
   "description": "an open api based custom connector for hrms"}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"
   

   Ersetzen Sie Folgendes:

   • CUSTOM_CONNECTOR_NAME: Ein Name für den benutzerdefinierten Connector.
   • PROJECT_ID: ID Ihres Google Cloud-Projekts.
   • UNIQUE_IDENTIFIER: Eine eindeutige Kennung für den Anschluss. Beispiel: custom-connector-1.
2. Konfigurieren Sie die Version des benutzerdefinierten Connectors.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -d '{"spec_location": "SPECIFICATION_URL",}' \
   "https://connectors.googleapis.comv1/projects/PROJECT_ID/locations/global/customConnectors/openapi-customconnector/customConnectorVersions?custom_connector_version_id=VERSION_NUMBER"
   

Ersetzen Sie Folgendes:

• SPECIFICATION_URL: Die URL der OpenAPI-Spezifikation. Beispiel:https://petstore3.swagger.io/api/v3/openapi.json.
• PROJECT_ID: ID Ihres Google Cloud-Projekts.
• VERSION_NUMBER: Eine Versionsnummer für den Connector. Beispiel: 2.

Mit indirekter Verbindung Inhalte erstellen

Einen benutzerdefinierten Connector erstellen, der über einem Zwischenendpunkt, gehen Sie so vor:

Console

1. Gehen Sie in der Console zu Seite Application Integration > Custom Connectors aus, Wählen Sie dann ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Zur Seite „Benutzerdefinierte Konnektoren“

2. Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
3. Legen Sie im Abschnitt Anschlussdetails die folgenden Felder fest:
   1. Name des Connectors: Geben Sie einen Namen für den Connector ein.
   2. Anzeigename: Geben Sie einen Anzeigenamen für den Connector ein.
   3. Beschreibung: Geben Sie eine Beschreibung ein.
   4. Connector-Ziel für Back-End-Zugriff konfigurieren: Aktivieren Sie diese Option. Hier werden die zusätzlichen Konfigurationsabschnitte auf der Seite angezeigt.
   5. Dienstkonto: Wählen Sie ein Dienstkonto mit den erforderlichen Rollen aus.
   6. Logo: Laden Sie das Bild in einen Cloud Storage-Bucket hoch, um es als Verbindungslogo zu verwenden.
      Hinweis: Für Ihren Cloud Storage-Bucket muss die Verhinderung des öffentlichen Zugriffs deaktiviert sein.
4. Klicken Sie auf Weiter.
5. Legen Sie im Abschnitt Connector-Spezifikation die folgenden Felder fest:
   1. Benutzerdefinierter Connector-Typ: Wählen Sie den benutzerdefinierten Connector-Typ aus.
   2. Connector-Spezifikation: Geben Sie entweder die öffentliche URL Ihrer Open API-Spezifikation ein oder laden Sie die Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
6. Klicken Sie auf Weiter.
7. Legen Sie im Bereich Connector-Ziel die folgenden Felder fest:
   1. Zieltyp: Wählen Sie Hostadresse aus.
   2. Host: Geben Sie den Hostnamen ein, auf dem der Vermittlungsdienst ausgeführt wird.
   3. Port: Geben Sie die Portnummer Ihres Intermediärdienstes ein.
8. Klicken Sie auf Weiter.
9. Wählen Sie im Abschnitt Connector-Authentifizierung den Authentifizierungstyp des Zwischendienstes aus und geben Sie dann die entsprechenden Details ein. In diesem Schritt konfigurieren Sie die Authentifizierung von Application Integration an den Vermittlungsdienst.

   Die Authentifizierung Konfiguration vom Vermittlungsdienst zum Backend kann nicht konfiguriert werden in Application Integration, obliegt der Vermittlungsdienst, Authentifizierung beim Back-End.

10. Klicken Sie auf Weiter.
11. Geben Sie im Bereich Back-End-Variablen die Werte ein, die den Sie über den Vermittlungsdienst an Ihr Back-End senden möchten. Sie müssen die Werte als Schlüssel/Wert-Paare konfigurieren. Wenn Sie ein Schlüssel/Wert-Paar eingeben möchten, klicken Sie auf Variable hinzufügen und legen Sie dann die folgenden Felder fest:
    • Schlüssel: Geben Sie den Schlüsselnamen ein.
    • Werttyp: Wählen Sie den Datentyp der Variablen aus.
    • Display name (Anzeigename): Geben Sie einen Anzeigenamen ein.
    • Speicherort: Geben Sie an, wie der Connector Daten senden soll. an den Vermittlungsdienst übergeben. Verfügbare Optionen sind Header, Request payload und Query parameter.
    • Wählen Sie optional Required aus, um anzugeben, dass ist die Variable eine obligatorische Variable.
    Hinweis: Beim Erstellen einer Verbindung werden Sie aufgefordert, die Werte der konfigurierten Variablen einzugeben.
12. Klicken Sie auf Weiter.
13. Prüfen Sie die Details der Connector-Konfiguration und klicken Sie dann auf Erstellen.

Wenn der Connector erfolgreich erstellt wurde, wird der neu erstellte Connector werden im Feld Benutzerdefinierte Seite „Connectors“. Wenn es sich um einen neuen Connector handelt, wird der Connector ebenfalls erstellt. Sie finden die Versionsdetails auf der Seite Details zum benutzerdefinierten Connector auf dem Tab Version. Informationen zum Erstellen und Bearbeiten einer benutzerdefinierten Connectorversion finden Sie unter Benutzerdefinierte Connectorversionen verwalten.

Beachten Sie jedoch, dass Sie für die Verbindung zu Ihrem Backend eine Verbindung für den neu erstellten Connector erstellen müssen. Weitere Informationen finden Sie unter Benutzerdefinierte Connector-Verbindung erstellen.

API

Die folgenden Beispielbefehle zeigen, wie Sie mithilfe der APIs zur Anwendungsintegration einen benutzerdefinierten Connector erstellen:

1. Erstellen Sie den Connector.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -d '{"customConnectorType":"OPEN_API", \
   "displayName":"CUSTOM_CONNECTOR_NAME", \
   "description": "an open api based custom connector for hrms"}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"
   

   Ersetzen Sie Folgendes:

   • CUSTOM_CONNECTOR_NAME: Ein Name für den benutzerdefinierten Connector.
   • PROJECT_ID: ID Ihres Google Cloud-Projekts.
   • UNIQUE_IDENTIFIER: Eine eindeutige Kennung für den Anschluss. Beispiel: custom-connector-1.
2. Konfigurieren Sie die Version des benutzerdefinierten Connectors und die Authentifizierung.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -d '{"spec_location": "SPECIFICATION_URL", \
   "service_account":"test-sa", \
   "enable_backend_destination_config": true, \
   "auth_config": { \
   "auth_type":"USER_PASSWORD", \
   "auth_key": "basic", \
   "user_password": { \
   "username":"USERNAME", \
   "password": {"secret_version":"projects/PROJECT_ID/secrets/fidelity-secret/versions/SECRET_VERSION_NUMBER"} \
   }}, \
   "backend_variable_templates": [{ \
   "key":"authkey", \
   "value_type":"SECRET", \
   "display_name":"Authorization Key", \
   "required":true, \
   "location_type": "HEADER" \
   }], \
   "destination_configs":[{ \
   "key":"base_url", \
   "destinations": [{ \
   "host":"DESTINATION_HOST_ADDRESS" \
   }]} \
   ]}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors/facade-connector/customConnectorVersions?custom_connector_version_id=CONNECTOR_VERSION_NUMBER"
   

Ersetzen Sie Folgendes:

• SPECIFICATION_URL: Die URL der OpenAPI-Spezifikation. Beispiel:https://petstore3.swagger.io/api/v3/openapi.json.
• PROJECT_ID: ID Ihres Google Cloud-Projekts.
• USERNAME: Nutzername für die Authentifizierung beim Vermittlungsdienst.
• SECRET_VERSION_NUMBER: Die Versionsnummer des Secret Manager-Secrets. Beispiel: 2.
• DESTINATION_HOST_ADDRESS: Hostadresse des Vermittlungsdienstes. Beispiel: http://www.test.com:80.
• CONNECTOR_VERSION_NUMBER: Die Versionsnummer des benutzerdefinierten Connectors. Beispiel: 1.
Hinweis: Für diesen Beispiel-API-Aufruf wird die Username and Password-Authentifizierung verwendet. Je nach Ihren Anforderungen können Sie einen anderen Authentifizierungstyp verwenden.

Benutzerdefinierte Connector-Verbindung erstellen

Nachdem Sie den benutzerdefinierten Connector erstellt haben, müssen Sie eine Verbindung vom Typ „Benutzerdefinierter Connector“ erstellen, um eine Verbindung zum Backend herzustellen. Im Folgenden finden Sie eine allgemeine Anleitung zum Erstellen einer neuen Verbindung:

1. Klicken Sie auf Neu erstellen, um die Seite Verbindung erstellen zu öffnen.
2. Wählen Sie im Abschnitt Standort im Feld Region einen Standort für die Verbindung aus.

   Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

3. Klicken Sie auf Weiter.
4. Legen Sie im Abschnitt Verbindungsdetails die folgenden Felder fest:
   1. Connector: Wählen Sie Ihren benutzerdefinierten Connector aus der Drop-down-Liste der verfügbaren Connectors aus.
   2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
   3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindung ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 63 Zeichen haben.
   4. Geben Sie optional eine Beschreibung für die Verbindung ein.
   5. Wählen Sie optional Cloud Logging aktivieren aus, um Cloud Logging zu aktivieren.
   6. Dienstkonto: Wählen Sie ein Dienstkonto aus, das über die erforderlichen Rollen verfügt.
   7. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:
      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

   Hinweis: Sie können die Verbindungsknotenwerte nur anpassen, wenn Sie ein „Pay as you go”-Kunde sind.
   8. Klicken Sie optional auf Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
5. Klicken Sie auf Weiter.
6. Geben Sie im Abschnitt Authentication (Authentifizierung) die Details zur Authentifizierung ein. für Ihr Back-End.
   • Wenn Sie eine direkte Verbindung zu Ihrem Backend herstellen, werden Sie von der Anwendungsintegration aufgefordert, die Authentifizierung für Ihr Backend zu konfigurieren.
   • Wenn Sie eine indirekte Verbindung über einen Zwischendienst zu Ihrem Backend herstellen, werden Sie in Application Integration nicht aufgefordert, Authentifizierungsdetails zu konfigurieren. Beim Erstellen des Connectors müssen Sie die Authentifizierung zwischen Application Integration und zwischengeschaltete Dienste. Sie müssen bei Application Integration keine Authentifizierung konfigurieren zwischen dem Vermittlungsdienst und dem Back-End. obliegt dem Vermittler wie die Authentifizierung beim Back-End erfolgen soll.
7. Klicken Sie auf Weiter.
8. Prüfen Sie die Details zur Verbindungskonfiguration und klicken Sie dann auf Erstellen.

Wenn die Verbindung erfolgreich erstellt wurde, wird sie auf der Seite Alle Verbindungen aufgeführt und ist für die Anwendungsintegration verfügbar. Sie können die Verbindung in Ihrer Integration über die Connectors-Aufgabe verwenden.

Hinweise

Beachten Sie beim Erstellen eines benutzerdefinierten Connectors die folgenden Punkte:

• Application Integration unterstützt nur OpenAPI Version 3.0 und alle zugehörigen Nebenversionen.
• Die OpenAPI-Spezifikation wird beim Erstellen des benutzerdefinierten Connectors nicht validiert. Wenn Sie eine Verbindung für den benutzerdefinierten Connector erstellen, wird die Spezifikation von der Anwendungsintegration validiert. Wenn Fehler auftreten, hat die Verbindung den Status Error.
• Bei der Anwendungsintegration wird nicht zwischen Entitäten und Aktionen unterschieden. Daher werden sowohl die Entitäten als auch die Aktionen Ihres Backends in Ihrem benutzerdefinierten Connector als Actions aufgeführt.
• Benutzerdefinierte Connectors werden in Google Cloud-Projekten nicht unterstützt, für die VPC Service Controls aktiviert ist.
• Sowohl der Endpunkt der OpenAPI-Spezifikation als auch der Back-End-Endpunkt sollten öffentlich zugänglich sein. Das bedeutet, dass Sie private Verbindung zu Ihrem Back-End herstellen.
• Der mehrteilige Medientyp wird in der OpenAPI-Spezifikation nicht unterstützt.
• Sie können die Versionsdetails eines benutzerdefinierten Connectors nicht bearbeiten.

Kontingente und Limits

Weitere Informationen zu allen Kontingenten und Limits finden Sie unter Kontingente und Limits.

Nächste Schritte

• Alle Aufgaben und Trigger.
• Hier erfahren Sie, wie Sie eine Integration testen und veröffentlichen.
• Weitere Informationen zur Fehlerbehandlung.
• Weitere Informationen zu Ausführungslogs der Integration.