Google Cloud Functions-Erweiterung

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

<ph type="x-smartling-placeholder">

Version 1.3.1

Cloud Functions-Funktionen aufrufen, die über Ihr Google Cloud-Projekt bereitgestellt werden

Derzeit unterstützt diese Erweiterung das Aufrufen von HTTP-Triggerfunktionen.

Vorbereitung

Dieser Inhalt bietet eine Referenz zum Konfigurieren und Verwenden dieser Erweiterung. Bevor Sie die Erweiterung über einen API-Proxy mithilfe der ExtensionCallout-Richtlinie verwenden können, müssen Sie:

  1. Aktivieren Sie die Cloud Functions API.

  2. Funktionen in Cloud Functions für Ihr Google Cloud-Projekt definieren und bereitstellen

  3. Gewähren Sie dem Nutzer über IAM Zugriff auf die gewünschte Zugriffsebene für die Funktion. Sie können beispielsweise den Zugriff auf die Funktion auf das Dienstkonto beschränken, mit dem Sie die Erweiterung konfigurieren.

  4. Generieren Sie mit der GCP Console einen Schlüssel für das Dienstkonto.

  5. Verwenden Sie den Inhalt der resultierenden JSON-Schlüsseldatei, wenn Sie die Erweiterung mithilfe der Konfigurationsreferenz hinzufügen und konfigurieren.

Informationen zu Cloud Functions

Mit Google Cloud Functions können Sie Funktionen in Google Cloud erstellen und bereitstellen und diese Funktionen dann aus anderem Code aufrufen. Eine Einführung in Cloud Functions finden Sie in einer der Kurzanleitungen.

Beispiele

Das folgende Beispiel zeigt, wie Funktionen in Cloud Functions mit der ExtensionCallout-Richtlinie aufgerufen werden.

Node.js-Funktion aufrufen

Das folgende Beispiel enthält eine ExtensionCallout-Richtlinie zum Aufrufen einer Google Cloud Functions-Erweiterung. Die Erweiterung nennt die Standardeinstellung „Hello World“. die beim Aktivieren der Cloud Functions API enthalten ist.

Der folgende Node.js-JavaScript-Code wird in Cloud Functions für ein GCP-Konto bereitgestellt. Wenn die Anfrage ein Nachrichtenattribut enthält, gibt der Code dies zurück. Andernfalls wird „Hello World!“ zurückgegeben. als Antwort geben.

/**
 * Responds to any HTTP request.
 *
 * @param {!express:Request} req HTTP request context.
 * @param {!express:Response} res HTTP response context.
 */
exports.helloWorld = (req, res) => {
  let message = req.query.message || req.body.message || 'Hello World!';
  res.status(200).send(message);
};

Dieses Beispiel enthält eine Google Cloud Functions-Erweiterung, die mit Anmeldedaten konfiguriert ist, die zur Authentifizierung und Autorisierung zum Aufrufen von Code in Cloud Functions erforderlich sind.

Der vorherige Funktionscode wird in Cloud Functions einfach als helloWorld gespeichert. Der folgende ExtensionCallout-Richtlinienkonfigurationscode verwendet diesen Namen zusammen mit den Regions- und Projekt-ID-Werten, die den Angaben der Cloud Functions-Umgebung entsprechen, in der die Funktion bereitgestellt wird.

<Action>invoke</Action>
<Input><![CDATA[
  {
    "region" : "us-central1",
    "projectId" : "my-project",
    "functionName" : "hello-world",
    "method" : "POST",
    "payload" : { "message" : "Hello yourself!" }
  }
]]></Input>
<Output parsed="false">function.response</Output>

Die folgende AssignMessage-Richtlinie erfasst den Antwortwert zu Fehlerbehebungszwecken.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Function-Response">
    <DisplayName>Get Function Response</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{function.response}</Payload>
    </Set>
</AssignMessage>

Die Antwort auf die obige Anfrage sieht so aus:

Hello yourself!

Der Standardwert von parsed ist true. In diesem Beispiel wird parsed="false" im <Output>-Tag der Richtlinie festgelegt. Dadurch wird verhindert, dass die Richtlinie die JSON-Antwort parst. Für die meisten Situationen bei Verwendung der Cloud Functions-Erweiterung legen Sie parsed="false" fest. Siehe <Output> .

Wenn die Cloud Functions-Funktion eine JSON-Antwort zurückgibt und Sie parsed="true" festlegen, ist die Antwort der Erweiterung eine Objektreferenz. Verwende die folgende Syntax, um die Antwort aus der Referenz zu extrahieren: {objectName}.{jsonKey}. Beispiel:

function.response.message

Aktionen

<ph type="x-smartling-placeholder">

aufrufen

Ruft eine Cloud Functions-Funktion auf.

Derzeit unterstützt diese Erweiterung das Aufrufen von HTTP-Triggerfunktionen.

Syntax

<Action>invoke</Action>
<Input><![CDATA[
  {
    "region" : "deployment-region",
    "projectId" : "project-id",
    "functionName" : "function-name",
    "method" : "http-method",
    "payload" : { json-payload }
  }
]]></Input>
<Output>function.response</Output>

Beispiel

<Action>invoke</Action>
<Input><![CDATA[
  {
    "region" : "us-central1",
    "projectId" : "my-project",
    "functionName" : "hello-world",
    "method" : "POST",
    "payload" : { "message" : "Hello yourself!" }
  }
]]></Input>
<Output>function.response</Output>

Anfrageparameter

Parameter Beschreibung Typ Default Erforderlich
Region Die Google Cloud-Region, in der die Funktion bereitgestellt wird. String. Keine. Ja.
projectId GCP-Projekt-ID. String. Keine. Ja.
functionName Der Name der aufzurufenden HTTP-Funktion. Dies ist der Name, den Sie beim Erstellen der Funktion verwendet haben (nicht unbedingt ein Name aus dem Code der Funktion). String. Keine. Ja.
method Die HTTP-Methode, die beim Aufrufen der Funktion verwendet werden soll. String. GET Nein.
payload Die Nutzlast, die mit dem Funktionsaufruf gesendet werden soll. JSON Keine. Nein.

Antwort

Der Antwortwert der angegebenen Funktion, falls vorhanden.

Antworteigenschaften

Keine.

Konfigurationsreferenz

Verwenden Sie Folgendes, wenn Sie diese Erweiterung zur Verwendung in API-Proxys konfigurieren und bereitstellen. Eine schrittweise Anleitung zum Konfigurieren einer Erweiterung mit der Apigee-Konsole finden Sie unter Erweiterung hinzufügen und konfigurieren.

Allgemeine Erweiterungseigenschaften

Für jede Erweiterung sind die folgenden Eigenschaften vorhanden.

Attribut Beschreibung Standard Erforderlich
name Der Name, den Sie dieser Konfiguration der Erweiterung zuweisen. Ja
packageName Name des Erweiterungspakets, wie von Apigee Edge angegeben. Ja
version Versionsnummer für das Erweiterungspaket, von dem Sie eine Erweiterung konfigurieren. Ja
configuration Konfigurationswert speziell für die Erweiterung, die Sie hinzufügen. Weitere Informationen finden Sie unter Eigenschaften für dieses Erweiterungspaket. Ja

Eigenschaften für dieses Erweiterungspaket

Geben Sie Werte für die folgenden Konfigurationseigenschaften an, die für diese Erweiterung spezifisch sind.

Attribut Beschreibung Standard Erforderlich
Anmeldedaten Bei Eingabe in die Apigee Edge-Konsole ist dies der Inhalt Ihrer Dienstkonto-Schlüsseldatei. Beim Senden über die Verwaltungs-API handelt es sich um einen base64-codierten Wert, der aus der Schlüsseldatei des Dienstkontos generiert wird. Keine. Ja.