Diese Seite wurde von der Cloud Translation API übersetzt.

Benutzerdefinierten Connector erstellen

Auf dieser Seite wird beschrieben, wie Sie einen benutzerdefinierten Connector erstellen. Um zu verstehen, was ein benutzerdefinierter Connector ist, Weitere Informationen zu benutzerdefinierten Connectors

So stellen Sie mit einem benutzerdefinierten Connector eine Verbindung zum Backend her: müssen Sie die folgenden Aufgaben ausführen:

Benutzerdefinierten Connector erstellen: In dieser Aufgabe definieren Sie den Vertrag zwischen Integration Connectors und Ihrem Endpunkt (Backend), indem Sie die OpenAPI-Spezifikation des Endpunkts angeben. Derzeit werden nur OpenAPI Version 3.0 und alle zugehörigen Nebenversionen unterstützt. Die Angabe der Spezifikation ist eine einmalige Aktivität.
Benutzerdefinierte Connector-Verbindung erstellen: In dieser Aufgabe konfigurieren Sie die Verbindungsdetails Ihres Back-Ends, wie den Hostnamen und die Authentifizierung. Für eine benutzerdefinierte Connectors verwenden, 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.

Inhalte 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

Gehen Sie in der Console zu Seite Integration Connectors > Benutzerdefinierte Connectors Wählen Sie dann ein Google Cloud-Projekt aus oder erstellen Sie eines.
Zur Seite „Benutzerdefinierte Connectors“
Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
Legen Sie im Abschnitt Anschlussdetails die folgenden Felder fest:
1. Connector-Name: 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 Connector-Logo zu verwenden.
  Hinweis: Für Ihren Cloud Storage-Bucket muss die Verhinderung des öffentlichen Zugriffs deaktiviert sein.
Klicken Sie auf Weiter.
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 OpenAPI-Spezifikation ein oder laden Sie Ihre Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
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 .

Wenn Sie eine Verbindung zu Ihrem Backend herstellen möchten, müssen Sie eine Verbindung für den neu erstellten Connector erstellen. Weitere Informationen Weitere Informationen

API

In den folgenden Beispielbefehlen wird gezeigt, wie Sie mithilfe der Integration Connectors APIs einen benutzerdefinierten Connector erstellen:

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 Connector. Beispiel: custom-connector-1.

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

Rufen Sie in der Console die Seite Integration Connectors > Custom connectors auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.
Zur Seite „Benutzerdefinierte Connectors“
Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
Legen Sie im Bereich Connector-Details die folgenden Felder fest:
1. Connector-Name: 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 den Back-End-Zugriff konfigurieren: Aktivieren Sie diese Option. Dadurch 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 Connector-Logo zu verwenden.
  Hinweis: Achten Sie darauf, dass die Verhinderung des öffentlichen Zugriffs für Ihren Cloud Storage-Bucket deaktiviert ist.
Klicken Sie auf Weiter.
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 OpenAPI-Spezifikation ein oder laden Sie Ihre Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
Klicken Sie auf Weiter.
Legen Sie im Bereich Connector-Ziel die folgenden Felder fest:
1. Zieltyp: Wählen Sie Hostadresse aus.
2. Host: Geben Sie den Hostnamen ein, unter dem Ihr Intermediärdienst ausgeführt wird.
3. Port: Geben Sie die Portnummer Ihres Vermittlungsdiensts ein.
Klicken Sie auf Weiter.
Wählen Sie im Bereich Connector-Authentifizierung die Option den Authentifizierungstyp des Vermittlungsdienstes geben Sie die entsprechenden Details ein, wenn Sie dazu aufgefordert werden. In diesem Schritt wird die Authentifizierung von Integration Connectors zum Intermediärdienst konfiguriert.
Die Authentifizierungskonfiguration vom Vermittlungsdienst zum Backend kann nicht in Integration Connectors konfiguriert werden. Es liegt im Ermessen des Vermittlungsdienstes, wie er sich beim Backend authentifizieren möchte.
Klicken Sie auf Weiter.
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. Um ein Schlüssel/Wert-Paar einzugeben, 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: Legen Sie fest, wie der Connector die Variablen an den Zwischendienst senden soll. Verfügbare Optionen sind Header, Request payload und Query parameter.
- Optional: Wählen Sie Required aus, um anzugeben, dass die Variable obligatorisch ist.
Hinweis: Sie werden aufgefordert, die Werte der die konfigurierten Variablen beim Erstellen einer Verbindung.
Klicken Sie auf Weiter.
Prüfen Sie die Details der Connectorkonfiguration und klicken Sie dann auf Erstellen.

Wenn die Erstellung des Connectors erfolgreich war, wird er auf der Seite Benutzerdefinierte Connectors angezeigt. Bei einem neuen Connector wird auch eine erste Version des Connectors erstellt. Die Versionsdetails finden Sie in der Version. auf der Seite Details zum benutzerdefinierten Connector. Weitere Informationen zu Erstellen und Bearbeiten einer benutzerdefinierten Connector-Version finden Sie unter Benutzerdefinierte Connector-Versionen 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

In den folgenden Beispielbefehlen wird gezeigt, wie Sie mithilfe der Integration Connectors APIs einen benutzerdefinierten Connector erstellen:

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.

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 Vermittlungsdiensts. Beispiel: http://www.test.com:80.
CONNECTOR_VERSION_NUMBER: Die Versionsnummer des benutzerdefinierten Connectors. Beispiel: 1.

Hinweis: Dieser beispielhafte API-Aufruf verwendet die Username and Password-Authentifizierung. 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 zum Herstellen einer Verbindung zu Ihrem Backend muss eine Verbindung des benutzerdefinierten Connector-Typs erstellen. Im Folgenden sind die allgemeine Schritte zum Erstellen einer neuen Verbindung:

Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.
Zur Seite „Verbindungen“
Klicken Sie auf Neu erstellen, um die Seite Verbindung erstellen zu öffnen.
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.
Klicken Sie auf Weiter.
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 unter Beschreibung eine Beschreibung für die Verbindung ein.
5. Optional können Sie Cloud Logging aktivieren auswählen, um Cloud Logging zu aktivieren.
6. Dienstkonto: Wählen Sie ein Dienstkonto aus, das über die erforderlichen Rollen verfügt.
7. Optional: Konfigurieren Sie die Verbindungsknoteneinstellungen:
  - 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.
8. Klicken Sie optional auf Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
Klicken Sie auf Weiter.
Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails für Ihr Backend ein.
- Wenn Sie eine direkte Verbindung zu Ihrem Back-End herstellen, werden Sie von Integration Connectors aufgefordert, die Authentifizierung für Ihr Back-End zu konfigurieren.
- Wenn Sie eine indirekte Verbindung über einen Zwischendienst zu Ihrem Backend herstellen, werden Sie in Integration Connectors nicht aufgefordert, Authentifizierungsdetails zu konfigurieren. Beim Erstellen des Connectors müssen Sie die Authentifizierung zwischen Integration Connectors und zwischengeschaltete Dienste. Bei Integration Connectors müssen Sie die Authentifizierung zwischen dem Intermediärdienst und dem Backend nicht konfigurieren. Es liegt im Ermessen des Intermediärdienstes, wie er sich beim Backend authentifizieren möchte.
Klicken Sie auf Weiter.
Prüfen Sie die Details der 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:

Integration Connectors unterstützt nur OpenAPI-Version 3.0 und alle zugehörigen Minor-Versionen.
Die OpenAPI-Spezifikation wird beim Erstellen eines benutzerdefinierten Connectors nicht validiert. Wenn Sie eine Verbindung für den benutzerdefinierten Connector erstellen, validiert Integration Connectors die Spezifikation und Falls Fehler vorliegen, hat die Verbindung den Status Error.
Integration Connectors unterscheidet nicht zwischen Entitäten und Aktionen. 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 keine private Verbindung zu Ihrem Backend herstellen können.
Der mehrteilige Medientyp wird in der OpenAPI-Spezifikation nicht unterstützt.
Die Versionsdetails eines benutzerdefinierten Connectors können nicht bearbeitet werden.