Mit der Aufgabe REST-Endpunkt aufrufen können Sie jede REST API eines Drittanbieters aus Ihrer Integration aufrufen. Die Antwort des REST API-Aufrufs ist in einer Integrationsvariablen verfügbar und kann in anderen nachgelagerten Aufgaben verwendet werden.
Wenn für die Integration sowohl ein OAuth 2.0-Profil als auch ein nutzerverwaltetes Dienstkonto konfiguriert sind, wird standardmäßig das OAuth 2.0-Profil zur Authentifizierung verwendet. Wenn weder das OAuth 2.0-Profil noch das nutzerverwaltete Dienstkonto konfiguriert ist, schlägt die Ausführung fehl.
Wenn an Ihre Integration ein Dienstkonto angehängt ist, weisen Sie basierend auf der REST-Endpunkt-URL dem Dienstkonto die erforderliche IAM-Rolle zu. Wenn beispielsweise Ihre REST-Endpunkt-URL einen Cloud Storage-Dienst aufruft, weisen Sie die erforderliche IAM-Rolle für den Cloud Storage-Dienst zu.
Auf der Seite Integrationen werden alle im Google Cloud-Projekt verfügbaren Integrationen aufgeführt.
Wählen Sie eine vorhandene Integration aus oder klicken Sie auf Integration erstellen, um eine neue zu erstellen.
Wenn Sie eine neue Integration erstellen, gehen Sie so vor:
Geben Sie im Bereich Integration erstellen einen Namen und eine Beschreibung ein.
Wählen Sie eine Region für die Integration aus.
Wählen Sie ein Dienstkonto für die Integration aus. Sie können die Dienstkontodetails einer Integration jederzeit im Bereich infoIntegrationsübersicht in der Symbolleiste für die Integration ändern oder aktualisieren.
Klicken Sie auf Erstellen. Die neu erstellte Integration wird im Integrationseditor geöffnet.
Klicken Sie in der Navigationsleiste des Integrationseditors auf Aufgaben, um die Liste der verfügbaren Aufgaben und Connectors aufzurufen.
Klicken Sie auf das Element REST-Endpunkt aufrufen und platzieren Sie es im Integrationseditor.
Klicken Sie im Designer auf das Element Call REST Endpoint, um den Aufgabenkonfigurationsbereich Call REST Endpoint aufzurufen.
Konfigurieren Sie die angezeigten Felder mithilfe den Konfigurationsattributen der Aufgabe, wie in der folgenden Tabelle beschrieben.
Änderungen an den Attributen werden automatisch gespeichert.
Konfigurationsattribute
In der folgenden Tabelle werden die Konfigurationsattribute der Aufgabe REST-Endpunkt aufrufen beschrieben.
Attribut
Datentyp
Beschreibung
Label
String
Optional: Fügen Sie ein Label für die Aufgabe hinzu.
Sie können eine der folgenden HTTP-Methoden auswählen:
DELETE
GET
HEAD
PATCH
POST
PUT
URL-Abfragestringparameter
Abfragestring-Schlüssel: String
Wert: String
Für den REST API-Aufruf erforderliche Abfrageparameter.
Die Abfrageparameter haben die Form von Schlüssel/Wert-Paaren, wobei der Schlüssel der Schlüsselname und der Wert der entsprechende Schlüsselwert ist. Sie können mehrere Schlüssel/Wert-Paare eingeben, indem Sie auf das Pluszeichen klicken.
HTTP-Header
HTTP-Header-Schlüssel: String
Wert: String
Für den REST API-Aufruf erforderliche HTTP-Header.
Die HTTP-Header haben die Form von Schlüssel/Wert-Paaren, wobei Schlüssel der Schlüsselname und der Wert der entsprechende Schlüsselwert ist. Sie können mehrere Schlüssel/Wert-Paare eingeben, indem Sie auf das Pluszeichen klicken.
Weiterleitungen folgen
Boolesch
URL-Weiterleitungen folgen.
Sie können einen der folgenden Werte auswählen:
True: Ruft die weitergeleitete URL auf, wenn die Basis-URL des Endpunkts an eine andere URL weitergeleitet wird.
False: Ruft die weitergeleitete URL nicht auf, wenn die Basis-URL des Endpunkts an eine andere URL weitergeleitet wird.
Aufgabe sollte bei HTTP-Fehler fehlschlagen
Boolesch
Strategie der Ausnahmebehandlung, wenn der REST API-Aufruf fehlschlägt.
Der REST-Endpunkt aufrufen schlägt fehl, wenn der HTTP-Antwortcode 4xx oder 5xx ist. Eine Liste der Fehlercodes finden Sie unter Fehlercodes. Geben Sie für andere HTTP-Antwortcodes den Fehlercode und die Fehlermeldung in der Antwort zurück.
Sie können einen der folgenden Werte auswählen:
True: Löst eine Ausnahme aus.
False: Löst keine Ausnahme aus. Gibt jedoch den Fehlercode und die Fehlermeldung in der Antwort zurück.
Antwort-Header (<Aufgabenname>)
String
Nicht komprimierter Antwortheader aus der Antwort der REST APIs.
Antworttext (<Aufgabenname>)
String
Nicht komprimierter Antworttext aus der Antwort der REST APIs.
Antwortstatus (<Aufgabenname>)
String
HTTP-Antwortcode und der entsprechende Codetext aus der Antwort der REST APIs.
Best Practices
Informationen zu den Nutzungslimits für die Aufgabe REST-Endpunkt aufrufen finden Sie unter Nutzungslimits.
Fehlerbehebungsstrategie
Eine Strategie zur Fehlerbehandlung für eine Aufgabe legt die Aktion fest, die ausgeführt werden soll, wenn die Aufgabe aufgrund eines temporären Fehlers fehlschlägt. Informationen zur Verwendung einer Fehlerbehandlungsstrategie und zu den verschiedenen Arten von Fehlerbehandlungsstrategien finden Sie unter Strategien zur Fehlerbehebung.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-09-03 (UTC)."],[[["\u003cp\u003eThe \u003cstrong\u003eCall REST Endpoint\u003c/strong\u003e task enables integrations to interact with any third-party REST API, with the response data being accessible for use in subsequent tasks.\u003c/p\u003e\n"],["\u003cp\u003eThis task is restricted to calling endpoints accessible over the public internet and cannot connect to resources within private networks like VPCs.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for REST API calls requires either a pre-configured OAuth 2.0 profile or an attached user-managed service account, however, authentication isn't needed if it's not required by the API.\u003c/p\u003e\n"],["\u003cp\u003eThe task supports various HTTP methods (DELETE, GET, HEAD, PATCH, POST, PUT) and allows for the configuration of URL query string parameters and HTTP headers.\u003c/p\u003e\n"],["\u003cp\u003eThe task has a response limit of 50 MB, and you can manage error handling, with the ability to throw exceptions or return error codes and messages based on HTTP status codes.\u003c/p\u003e\n"]]],[],null,["# Call REST Endpoint task\n\nSee the [supported connectors](/integration-connectors/docs/connector-reference-overview) for Application Integration.\n\nCall REST Endpoint task\n=======================\n\nThe **Call REST Endpoint** task lets you call any third-party REST\nAPI from your integration. The response from the REST API call will be available to\nyou in an integration variable and can be used in other down-stream tasks.\n| **Note:**\n|\n| - The network configuration of the **Call REST Endpoint** task allows it to call endpoints only available over the public internet. Hence, the task can't connect to hosts or IPs that reside only within a private network such as a VPC, even if that VPC is peered with your other Google Cloud services such as Apigee X.\n| - This task can process a maximum of 50 MB of REST response.\n\nBefore you begin\n----------------\n\n- To connect to an authentication endpoint for the REST API call, ensure that you have either [created\n an OAuth 2.0 profile](/application-integration/docs/configuring-auth-profile#createAuthProfile) or [attached a user-managed service account](/application-integration/docs/access-control#add-service-account) to your integration. If your API does not require authentication, then the **Authentication profile** field in the task configuration pane can be left empty. To see a list of configurations, see [Configuration properties](#params).\n\n If your integration has both OAuth 2.0 profile and a user-managed service account configured, then by default the OAuth 2.0 profile is used for authentication. If neither OAuth 2.0 profile nor user-managed service account is configured, then the execution fails.\n- If your integration has a service account attached, then based on the REST endpoint URL, grant the required IAM role to that service account. For example, if your REST endpoint URL calls a Cloud Storage service, then grant the required IAM role for the Cloud Storage service. For information about granting roles to a service account, see [Manage access to service accounts](/iam/docs/manage-access-service-accounts).\n\n- Ensure that [VPC Service Controls](/application-integration/docs/vpc-service-controls) is **NOT** setup for Application Integration in your Google Cloud project. **Warning:** **Cloud Function** does not function or stops functioning if [VPC Service Controls](/application-integration/docs/vpc-service-controls) is setup for Application Integration in your Google Cloud project.\n\nConfigure the Call REST Endpoint task\n-------------------------------------\n\nTo configure the **Call REST Endpoint** task:\n\n1. In the Google Cloud console, go to the **Application Integration** page.\n\n [Go to Application Integration](https://console.cloud.google.com/integrations)\n2. In the navigation menu, click **Integrations** .\n\n\n The **Integrations** page appears listing all the integrations available in the Google Cloud project.\n3. Select an existing integration or click **Create integration** to create a new one.\n\n\n If you are creating a new integration:\n 1. Enter a name and description in the **Create Integration** pane.\n 2. Select a region for the integration. **Note:** The **Regions** dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, click **Enable Region** . See [Enable new region](/application-integration/docs/enable-new-region) for more information.\n 3. Select a service account for the integration. You can change or update the service account details of an integration any time from the info **Integration summary** pane in the integration toolbar. **Note:** The option to select a service account is displayed only if you have enabled integration governance for the selected region.\n 4. Click **Create** . The newly created integration opens in the *integration editor*.\n\n\n4. In the *integration editor* navigation bar, click **Tasks** to view the list of available tasks and connectors.\n5. Click and place the **Call REST Endpoint** element in the integration editor.\n6. Click the **Call REST Endpoint** element on the designer to view the **Call REST Endpoint** task configuration pane.\n7. Configure the displayed fields using the [configuration properties](#params) of the task as detailed in the table below.\n\n\n Changes to the properties are saved automatically.\n | **Note:** If you update the authentication profile for a **Call REST Endpoint** task, and test the integration without publishing the changes, the integration uses the old authentication profile. To ensure that the integration uses the updated authentication profile, you must [publish the integration](https://cloud.google.com/application-integration/docs/test-publish-integrations) before testing.\n\nConfiguration properties\n------------------------\n\n\nThe following table describes the configuration properties of the **Call REST Endpoint** task.\n\nBest practices\n--------------\n\nFor information about the usage limits that apply to the **Call REST Endpoint** task, see [Usage limits](/application-integration/docs/quotas#usage-limits).\n\nError handling strategy\n-----------------------\n\n\nAn error handling strategy for a task specifies the action to take if the task fails due to a [temporary error](/application-integration/docs/error-handling). For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see [Error handling strategies](/application-integration/docs/error-handling-strategy).\n\nTo learn how to handle retry strategies for `4xx` or `5xx` errors, see the [How to retry Rest Caller Task based on Response Status](https://www.googlecloudcommunity.com/gc/Integration-Services/How-to-retry-Rest-Caller-Task-based-on-Response-Status/m-p/618079) blog.\n\nQuotas and limits\n-----------------\n\nFor information about quotas and limits, see [Quotas and limits](/application-integration/docs/quotas).\n\nWhat's next\n-----------\n\n- Learn about [all tasks and triggers](/application-integration/docs/all-triggers-tasks).\n- Learn how to [test and publish an integration](/application-integration/docs/test-publish-integrations).\n- Learn about [error handling](/application-integration/docs/error-handling-strategy).\n- Learn about [integration execution logs](/application-integration/docs/introduction-logs)."]]
