Cloud Endpoints OpenAPI für Cloud Functions mit ESPv2 einrichten

Auf dieser Seite wird beschrieben, wie Sie Cloud Endpoints für Cloud Functions einrichten können. Endpoints verwendet Extensible Service Proxy V2 (ESPv2) als API-Gateway. Damit die API-Verwaltung für Cloud Functions verfügbar ist, stellen Sie den vordefinierten ESPv2-Container für Cloud Run bereit. Anschließend sichern Sie Ihre Funktionen mit Cloud Functions IAM, sodass ESPv2 diese aufrufen kann.

Mit dieser Konfiguration fängt ESPv2 alle Anfragen an Ihre Funktionen ab und führt vor dem Aufrufen einer Funktion die erforderlichen Prüfungen (z. B. Authentifizierung) durch. Wenn der Dienst antwortet, sammelt und meldet ESPv2 Telemetriedaten, wie in der folgenden Abbildung dargestellt. Die Messwerte für die Funktion können Sie in der Google Cloud Console auf der Seite Endpunkte > Dienste ansehen.

Endpoints-Architektur

Eine Übersicht über Cloud Endpoints finden Sie in den Abschnitten Über Cloud Endpoints und Endpoints-Architektur.

Zu ESPv2 migrieren

In früheren Versionen von Cloud Endpoints wurde die Verwendung von Extensible Service Proxy (ESP) mit Cloud Functions unterstützt. Wenn bereits APIs vorhanden sind, die Sie zu ESPv2 migrieren möchten, finden Sie weitere Informationen unter Zu Extensible Service Proxy V2 migrieren.

Aufgabenliste

Verwenden Sie beim Durcharbeiten der Anleitung die folgende Aufgabenliste. Alle Aufgaben müssen ausgeführt werden, damit diese Anleitung abgeschlossen werden kann.

Erstellen Sie ein Google Cloud-Projekt. Wenn Sie Cloud Functions nicht selbst bereitgestellt haben, stellen Sie eine Beispiel-Back-End-Funktion bereit. Siehe Vorbereitung.
Reservieren Sie einen Cloud Run-Hostnamen für den ESPv2-Dienst. Weitere Informationen erhalten Sie unter Cloud Run-Hostname reservieren.
Erstellen Sie ein OpenAPI-Dokument, das Ihre API beschreibt, und konfigurieren Sie die Routen zu Cloud Functions. Siehe Endpoints konfigurieren.
Stellen Sie das OpenAPI-Dokument bereit, um einen verwalteten Dienst zu erstellen. Siehe Endpoints-Konfiguration bereitstellen.
Erstellen Sie ein neues ESPv2-Docker-Image mit Ihrer Endpoints-Dienstkonfiguration. Siehe Neues ESPv2-Image erstellen.
Stellen Sie den ESPv2-Container für Cloud Run bereit. Erteilen Sie dann ESPv2 die Berechtigung von Identity and Access Management (IAM) zum Aufrufen Ihres Dienstes. Siehe ESPv2-Container bereitstellen.
Rufen Sie eine Funktion auf. Siehe Anfrage an die API senden.
Verfolgen Sie Aktivitäten der Funktionen. Siehe API-Aktivitäten verfolgen.
Vermeiden Sie Gebühren, die Ihrem Google Cloud-Konto in Rechnung gestellt werden. Siehe Bereinigen.

Kosten

In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen. Neuen Google Cloud-Nutzern steht möglicherweise eine kostenlose Testversion zur Verfügung.

Nach Abschluss der in diesem Dokument beschriebenen Aufgaben können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Hinweise

Bevor Sie Endpoints für Cloud Functions verwenden, empfehlen wir Ihnen Folgendes:

Erstellen Sie ein neues Google Cloud-Projekt für die Bereitstellung des ESPv2 Beta-Containers für Cloud Run.
Erstellen Sie entweder ein neues Projekt oder wählen Sie ein vorhandenes Projekt für Ihre Cloud Functions-Funktionen aus.

Einrichtung vorbereiten:

Rufen Sie in der Google Cloud Console die Seite Ressourcen verwalten auf und erstellen Sie ein Projekt.
Zur Seite "Ressourcen verwalten"
Die Abrechnung für Ihr Projekt muss aktiviert sein.
Weitere Informationen zum Aktivieren der Abrechnung
Notieren Sie die Projekt-ID für die nächsten Schritte. Nachstehend wird hier die Projekt-ID als ESP_PROJECT_ID bezeichnet.
Notieren Sie die Projektnummer für die nächsten Schritte. Nachstehend wird die Projektnummer als ESP_PROJECT_NUMBER bezeichnet.
Laden Sie die Google Cloud CLI herunter und installieren Sie sie.
gcloud CLI herunterladen
Wenn Sie noch keine eigene Back-End-Cloud Functions-Funktion bereitgestellt haben, führen Sie die Schritte in der Kurzanleitung: Google Cloud CLI verwenden aus, um ein Google Cloud-Projekt auszuwählen oder zu erstellen und eine Beispielfunktion bereitzustellen. Notieren Sie die Region, in der Ihre Funktionen bereitgestellt werden, und die Projekt-ID. Nachstehend wird die Projekt-ID als FUNCTIONS_PROJECT_ID bezeichnet.

Cloud Run-Hostname reservieren

Sie müssen einen Cloud Run-Hostnamen für den ESPv2-Dienst reservieren, um das OpenAPI-Dokument oder die gRPC-Dienstkonfiguration zu configure. Zur Reservierung eines Hostnamens stellen Sie einen Beispielcontainer für Cloud Run bereit. Später führen Sie eine deploy des ESPv2-Containers für den gleichen Cloud Run-Dienst aus.

Prüfen Sie, ob die gcloud CLI für den Zugriff auf Ihre Daten und Dienste berechtigt ist.
1. Melden Sie sich an.
```
gcloud auth login
```
2. Ein neuer Browsertab wird geöffnet. Wählen Sie dort ein Konto aus, das in dem Google Cloud-Projekt, das Sie für die Bereitstellung von ESPv2 für Cloud Run erstellt haben, die Rolle Bearbeiter oder Inhaber hat.

Legen Sie die Region fest.

gcloud config set run/region us-central1

Stellen Sie das Beispiel-Image gcr.io/cloudrun/hello für Cloud Run bereit. Ersetzen Sie CLOUD_RUN_SERVICE_NAME durch den Namen, den Sie für den Dienst verwenden möchten.
```
gcloud run deploy CLOUD_RUN_SERVICE_NAME \
    --image="gcr.io/cloudrun/hello" \
    --allow-unauthenticated \
    --platform managed \
    --project=ESP_PROJECT_ID
```
Bei erfolgreicher Befehlsausführung wird eine Meldung angezeigt, die in etwa so aussieht:
```
Service [CLOUD_RUN_SERVICE_NAME] revision [CLOUD_RUN_SERVICE_NAME-REVISION_NUM] has been deployed and is serving traffic at CLOUD_RUN_SERVICE_URL
```
Hier ein Beispiel, in dem CLOUD_RUN_SERVICE_NAME auf gateway festgelegt ist:
```
Service [gateway] revision [gateway-00001] has been deployed and is serving traffic at https://gateway-12345-uc.a.run.app
```
In diesem Beispiel ist https://gateway-12345-uc.a.run.app die CLOUD_RUN_SERVICE_URL und gateway-12345-uc.a.run.app der CLOUD_RUN_HOSTNAME.
Notieren Sie sich CLOUD_RUN_SERVICE_NAME und CLOUD_RUN_HOSTNAME. Später stellen Sie ESPv2 für den Cloud Run-Dienst CLOUD_RUN_SERVICE_NAME bereit. Sie geben CLOUD_RUN_HOSTNAME im Feld host Ihres OpenAPI-Dokuments an.

Endpoints konfigurieren

Sie benötigen ein OpenAPI-Dokument auf Grundlage der OpenAPI-Spezifikation Version 2.0, das die Oberfläche der Funktionen und etwaige Authentifizierungsanforderungen beschreibt. Außerdem müssen Sie ein für Google spezifisches Feld hinzufügen, das die URL für jede Funktion enthält, damit ESPv2 die zum Aufrufen einer Funktion erforderlichen Informationen zur Verfügung stehen. Falls Sie mit OpenAPI noch nicht vertraut sind, stehen unter OpenAPI weitere Informationen bereit.

Erstellen Sie eine Textdatei mit dem Namen openapi-functions.yaml. (Der Einfachheit halber wird das OpenAPI-Dokument hier so genannt, Sie können es jedoch auch beliebig anders benennen.)

Jede Ihrer Funktionen muss im Abschnitt paths der Datei openapi-functions.yaml aufgeführt sein. Beispiel:

swagger: '2.0'
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
host: HOST
schemes:
  - https
produces:
  - application/json
paths:
  /hello:
    get:
      summary: Greet a user
      operationId: hello
      x-google-backend:
        address: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net/FUNCTIONS_NAME
        protocol: h2
      responses:
        '200':
          description: A successful response
          schema:
            type: string

Die Einrückung ist für das YAML-Format wichtig. Das Feld host muss beispielsweise auf derselben Ebene wie info sein.

Ersetzen Sie REGION im Feld address des Abschnitts x-google-backend durch die Google Cloud-Region, in der sich die Funktion befindet, FUNCTIONS_PROJECT_ID durch Ihre Google Cloud-Projekt-ID und FUNCTIONS_NAME durch den Funktionsnamen. Beispiel:
```
x-google-backend:
  address: https://us-central1-myproject.cloudfunctions.net/helloGET
```
Wenn Sie Ihre Cloud Functions-Funktion sichern möchten, indem sie nur ESPv2 aufrufen darf, stellen Sie sicher, dass das Feld address den Funktionsnamen enthält, wenn jwt_audience nicht angegeben ist. Beispiel:
```
x-google-backend:
  address: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net/FUNCTIONS_NAME
  path_translation: CONSTANT_ADDRESS
```
Wenn der jwt_audience angegeben ist, sollte dessen Wert auch den Funktionsnamen enthalten. Beispiel:
```
x-google-backend:
  address: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net
  jwt_audience: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net/FUNCTIONS_NAME
  path_translation: APPEND_PATH_TO_ADDRESS
```
ESPv2 generiert ein ID-Token, wenn die Cloud-Funktion zur Authentifizierung aufgerufen wird. Das ID-Token sollte einen geeigneten audience haben, der den Funktionshost und den Funktionsnamen angibt. ESPv2 legt audience für das ID-Token mithilfe des Werts im Feld jwt_audience fest, sofern angegeben. Andernfalls wird das Feld address verwendet.
Legen Sie im Feld host den Wert CLOUD_RUN_HOSTNAME fest. Dies ist der Hostname in der URL, der oben unter Cloud Run-Hostname reservieren reserviert wurde. Lassen Sie dabei die Protokollkennung https:// weg. Beispiel:
```
swagger: '2.0'
  info:
    title: Cloud Endpoints + GCF
    description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
    version: 1.0.0
  host: gateway-12345-uc.a.run.app
```
Beachten Sie den Wert des Attributs title in der Datei openapi-functions.yaml:
```
title: Cloud Endpoints + GCF
```
Der Wert des Attributs title wird nach Bereitstellung der Konfiguration zum Namen des Endpoints-Dienstes.
Speichern Sie das OpenAPI-Dokument.

Informationen zu den Feldern im OpenAPI-Dokument, die für Endpoints erforderlich sind, finden Sie unter Endpoints konfigurieren.

Endpoints-Konfiguration bereitstellen

Die Endpoints-Konfiguration wird mit dem Befehl gcloud endpoints services deploy bereitgestellt. Dieser Befehl erstellt mithilfe von Service Management einen verwalteten Dienst.

So stellen Sie die Endpoints-Konfiguration bereit:

Achten Sie darauf, dass Sie sich in dem Verzeichnis befinden, das Ihr OpenAPI-Dokument enthält.
Laden Sie die Konfiguration hoch und erstellen Sie einen verwalteten Dienst.
```
gcloud endpoints services deploy openapi-functions.yaml \
    --project ESP_PROJECT_ID
```
Dadurch wird ein neuer Endpoints-Dienst mit dem Namen erstellt, den Sie in der Datei openapi-functions.yaml im Feld host angegeben haben. Der Dienst wird dem OpenAPI-Dokument entsprechend konfiguriert.

Beim Erstellen und Konfigurieren des Dienstes gibt Service Management Informationen an das Terminal aus. Nach Abschluss der Bereitstellung erhalten Sie eine Meldung, die in etwa so aussieht:
```
Service Configuration [CONFIG_ID] uploaded for service [CLOUD_RUN_HOSTNAME]
```
CONFIG_ID ist die eindeutige Endpoints-Dienstkonfigurations-ID, die von der Bereitstellung erstellt wird. Beispiel:
```
Service Configuration [2019-02-01r0] uploaded for service [gateway-12345-uc.a.run.app]
```
Die Dienstkonfigurations-ID besteht aus einem Datumsstempel, gefolgt von einer Überarbeitungsnummer. Wenn Sie openapi-functions.yaml am selben Tag noch einmal bereitstellen, wird die Überarbeitungsnummer in der Dienstkonfigurations-ID erhöht. Sie können die Dienstkonfiguration und den Bereitstellungsverlauf in der Google Cloud Console auf der Seite Endpunkte > Dienste ansehen.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie Fehlerbehebung bei der Bereitstellung von Cloud Endpoints-Konfigurationen.

Erforderliche Dienste prüfen

Für Endpoints und den ESP müssen mindestens die folgenden Google-Dienste aktiviert sein:

Name	Titel
`servicemanagement.googleapis.com`	Service Management API
`servicecontrol.googleapis.com`	Service Control API
`endpoints.googleapis.com`	Google Cloud Endpoints

In der Regel werden die erforderlichen Dienste mit dem Befehl gcloud endpoints services deploy aktiviert. Unter folgenden Umständen kann es vorkommen, dass der Befehl gcloud erfolgreich ausgeführt wird, die erforderlichen Dienste jedoch nicht aktiviert werden:

Wenn Sie eine Drittanbieteranwendung wie Terraform verwendet haben und Sie diese Dienste nicht hinzufügen.
Wenn Sie die Endpoints-Konfiguration für ein vorhandenes Google Cloud-Projekt bereitgestellt haben, in dem diese Dienste explizit deaktiviert wurden.

Prüfen Sie mit dem folgenden Befehl, ob die erforderlichen Dienste aktiviert sind:

gcloud services list

Wenn die erforderlichen Dienste nicht aufgeführt sind, müssen Sie sie aktivieren:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Aktivieren Sie auch Ihren Endpoints-Dienst:

gcloud services enable ENDPOINTS_SERVICE_NAME

Zum Ermitteln des ENDPOINTS_SERVICE_NAME haben Sie folgende Möglichkeiten:

Rufen Sie nach der Bereitstellung der Endpoints-Konfiguration die Seite Endpunkte in der Cloud Console auf. Die Liste der möglichen ENDPOINTS_SERVICE_NAME wird in der Spalte Dienstname angezeigt.
Bei OpenAPI ist ENDPOINTS_SERVICE_NAME der Wert, den Sie im Feld host Ihrer OpenAPI-Spezifikation angegeben haben. Bei gRPC ist der ENDPOINTS_SERVICE_NAME das, was Sie im Feld name Ihrer gRPC-Endpoints-Konfiguration angegeben haben.

Weitere Informationen zu den gcloud-Befehlen finden Sie unter gcloud-Dienste.

Neues ESPv2-Image erstellen

Erstellen Sie die Endpoints-Dienstkonfiguration in einem neuen Docker-Image für ESPv2. Später werden Sie dieses Image für den reservierten Cloud Run-Dienst bereitstellen.

Hinweis:

Dieser Schritt ist erforderlich.

Die Dienstkonfiguration muss in ein neues Docker-Image integriert werden, da Cloud Run ein Dienst ist, der auf null skaliert wird. Das heißt, dass alle Instanzen gelöscht werden, wenn kein Traffic vorhanden ist. Wenn der Traffic zunimmt, werden nach Bedarf neue Instanzen erstellt. Diese Art der Erstellung von Dienstinstanzen wird auch als Kaltstart bezeichnet. Weitere Informationen finden Sie in der Cloud Run-Dokumentation zur Gleichzeitigkeit.

Wäre die Dienstkonfiguration nicht in das Docker-Image integriert, müsste Cloud Run bei jedem Kaltstart zwei API-Aufrufe an Google Service Management senden. Diese Aufrufe würden dann auf Ihr Google Service Management API-Kontingent angerechnet werden.

Durch das Integrieren der Dienstkonfiguration in das ESPv2-Docker-Image fallen nicht nur die zwei API-Aufrufe und damit die Auswirkungen auf das Kontingent für den Google ServiceManagement-Dienst weg. Durch diesen Schritt wird außerdem die Erstellung der neuen Dienstinstanz beschleunigt und die Latenz für Anfragen, die auf die neue Instanz warten, reduziert.

Sie müssen den gesamten Schritt noch einmal ausführen und den neuen Container noch einmal bereitstellen:

Jedes Mal, wenn Sie die Endpoints-Dienstkonfiguration ändern und neu bereitstellen. Andernfalls werden Änderungen an der Dienstkonfiguration nicht an ESPv2 weitergegeben.
Wenn eine neue Version von ESPv2 veröffentlicht wird. Andernfalls wird die ältere Version von ESPv2 weiterhin bereitgestellt.

So integrieren Sie die Dienstkonfiguration in ein neues ESPv2-Docker-Image:

Laden Sie dieses Skript auf Ihren lokalen Computer herunter, auf dem die gcloud CLI installiert ist.

Hinweis:
Dieses Skript benötigt Bash. Wenn Sie nicht macOS/Linux verwenden, können Sie es in Cloud Shell, Compute Engine oder einem Windows-Subsystem für Linux ausführen.

Führen Sie das Skript mit dem folgenden Befehl aus:

chmod +x gcloud_build_image

./gcloud_build_image -s CLOUD_RUN_HOSTNAME \
    -c CONFIG_ID -p ESP_PROJECT_ID

Geben Sie unter CLOUD_RUN_HOSTNAME den Hostnamen der URL ein, den Sie oben unter Cloud Run-Hostname reservieren reserviert haben. Lassen Sie dabei die Protokollkennung https:// weg.

Beispiel:

chmod +x gcloud_build_image

./gcloud_build_image -s gateway-12345-uc.a.run.app \
    -c 2019-02-01r0 -p your-project-id

Das Skript verwendet den gcloud-Befehl, um die Dienstkonfiguration herunterzuladen, die Dienstkonfiguration in ein neues ESPv2-Image einzubinden und das neue Image in Ihre Projekt-Container Registry hochzuladen. Das Skript verwendet automatisch den neuesten Release von ESPv2, der durch ESP_VERSION im Ausgabe-Image-Namen angegeben ist. Das Ausgabebild wird hochgeladen in:
```
gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID
```
Beispiel:
```
gcr.io/your-project-id/endpoints-runtime-serverless:2.14.0-gateway-12345-uc.a.run.app-2019-02-01r0"
```
Hinweis:
Übergeben Sie das -z-Flag an das Skript, um das Image an einem anderen Registry-Speicherort zu generieren.

Beispiel: Wenn Sie das generierte ESPv2-Image in ein Rechenzentrum der Europäischen Union übertragen möchten, übergeben Sie -z eu an das Skript.

ESPv2-Container bereitstellen

Stellen Sie den Cloud Run-Dienst von ESPv2 mit dem neuen Image bereit, das Sie oben erstellt haben. Ersetzen Sie dabei CLOUD_RUN_SERVICE_NAME durch den Cloud Run-Dienstnamen, den Sie bei der ursprünglichen Reservierung des Hostnamens im Abschnitt Cloud Run-Hostname reservieren verwendet haben:
```
gcloud run deploy CLOUD_RUN_SERVICE_NAME \
  --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID" \
  --allow-unauthenticated \
  --platform managed \
  --project=ESP_PROJECT_ID
```
Hinweis:
Wenn ESPv2 den Zugriff verwalten soll, verwenden Sie das --allow-unauthenticated-Flag, damit ESPv2 das JWT-Token prüft. Wird das Flag nicht verwendet, so wird das JWT-Token abgefangen und vom Cloud Run <a=" docs=""managing-access"="" run="" secure=""> Zugriffssteuerung-IAM-Server geprüft. Da IAM und ESPv2 denselben Autorisierungsheader nutzen, arbeiten sie nicht zusammen. Achten Sie darauf, nur einen davon zu verwenden. Verwenden Sie zur Verwaltung des Zugriffs IAM statt ESPv2.</a=">
Wenn Sie Endpoints so konfigurieren möchten, dass zusätzliche ESPv2-Startoptionen wie das Aktivieren von CORS verwendet werden, können Sie die Argumente in der Umgebungsvariablen ESPv2_ARGS übergeben:
```
gcloud run deploy CLOUD_RUN_SERVICE_NAME \
  --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID" \
  --set-env-vars=ESPv2_ARGS=--cors_preset=basic \
  --allow-unauthenticated \
  --platform managed \
  --project ESP_PROJECT_ID
```
Weitere Informationen und Beispiele zum Festlegen der Umgebungsvariablen ESPv2_ARGS, einschließlich der Liste der verfügbaren Optionen und Informationen zur Angabe mehrerer Optionen, finden Sie unter Startoptionen von Extensible Service Proxy V2 Beta.
Erteilen Sie ESPv2 die Berechtigung zum Aufrufen von Service Management und Service Control.

Rufen Sie in der Google Cloud Console die Seite „Cloud Run“ auf.

Zur Seite „Cloud Run“

Sie können die bereitgestellte Cloud Run-Instanz und das damit verknüpfte Dienstkonto sehen.
Gewähren Sie Berechtigungen für das Dienstkonto.

gcloud projects add-iam-policy-binding PROJECT_NAME \
   --member "serviceAccount:SERVICE_ACCOUNT" \
   --role roles/servicemanagement.serviceController

Was sind Rollen und Berechtigungen?

Erteilen Sie ESPv2 die Berechtigung zum Aufrufen Ihrer Funktionen. Führen Sie für jede Funktion den folgenden Befehl aus. Dazu nehmen Sie im Befehlstext zuerst folgende Ersetzungen vor:

Hinweis:
Dieser Schritt ist nicht erforderlich, wenn der Cloud Run-Dienst von ESPv2 ohne das Flag --service-account und der Back-End-Dienst BACKEND_SERVICE_NAME im Projekt ESP_PROJECT_NUMBER bereitgestellt wird.
- Ersetzen Sie FUNCTION_NAME durch den Namen Ihrer Funktion und FUNCTION_REGION durch die Region, in der die Funktion bereitgestellt wird. Wenn Sie die Funktion verwenden, die in der Kurzanleitung: Google Cloud CLI verwenden erstellt wurde, geben Sie helloGET als Namen an.
- Ersetzen Sie ESP_PROJECT_NUMBER durch die Projektnummer des Projekts, das Sie für ESPv2 erstellt haben. Sie finden dies beispielsweise, indem Sie in der Google Cloud Console die Seite IAM aufrufen und das Compute-Standarddienstkonto suchen. Dies ist das Dienstkonto, das im Flag member verwendet wird.
```
gcloud functions add-iam-policy-binding FUNCTION_NAME \
   --region FUNCTION_REGION \
   --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
   --role "roles/cloudfunctions.invoker" \
   --project FUNCTIONS_PROJECT_ID
```

Weitere Informationen finden Sie unter Zugriff über IAM verwalten.

Anfragen an die API senden

In diesem Abschnitt wird beschrieben, wie Sie Anfragen an die API senden.

Erstellen Sie eine Umgebungsvariable für den Endpoints-Dienstnamen. Das ist der Name, den Sie im Feld host Ihres OpenAPI-Dokuments angegeben haben. Beispiel:
- Linux oder MacOS:
  
  export ENDPOINTS_HOST=gateway-12345-uc.a.run.app
- Windows PowerShell:
  
  $Env: ENDPOINTS_HOST="gateway-12345-uc.a.run.app"

Linux oder macOS

Senden Sie mit curl eine HTTP-Anfrage mithilfe der im vorherigen Schritt festgelegten Umgebungsvariable ENDPOINTS_HOST.

curl --request GET \
   --header "content-type:application/json" \
   "https://${ENDPOINTS_HOST}/hello"

PowerShell

Senden Sie mit Invoke-WebRequest eine HTTP-Anfrage mithilfe der im vorherigen Schritt festgelegten Umgebungsvariable ENDPOINTS_HOST.

(Invoke-WebRequest -Method GET `
    -Headers @{"content-type"="application/json"} `
    -URI "https://$Env:ENDPOINTS_HOST/hello").Content

In diesem Beispiel enden die ersten beiden Zeilen mit einem Graviszeichen. Achten Sie beim Einfügen des Beispiels in PowerShell darauf, dass nach dem Graviszeichen kein Leerzeichen folgt. Informationen zu den in der Beispielanfrage verwendeten Optionen finden Sie in der Microsoft-Dokumentation unter Invoke-WebRequest.

Drittanbieteranwendung

Sie können auch eine Drittanbieteranwendung wie die Chrome-Browsererweiterung Postman verwenden.

Wählen Sie als HTTP-Verb GET aus.
Wählen Sie für den Header den Schlüssel content-type und den Wert application/json aus.
Verwenden Sie anstelle der Umgebungsvariablen die tatsächliche URL. Beispiel:
```
https://gateway-12345-uc.a.run.app/hello
```

Wenn als Antwort ein Fehler zurückgegeben wird, lesen Sie die Informationen unter Fehlerbehebung bei Antwortfehlern.

Sie haben gerade eine API in Cloud Endpoints bereitgestellt und getestet!

API-Aktivität verfolgen

Sehen Sie sich in der Google Cloud Console auf der Seite Endpunkte > Dienste die Aktivitätsgrafiken für Ihre API an.

Endpoints-Aktivitätsgrafiken ansehen

Es kann einen Moment dauern, bis die Anfrage in den Grafiken angezeigt wird.
Sehen Sie sich auf der Seite "Log Explorer" die Anfragelogs an. Endpoints-Anfragelogs ansehen

Entwicklerportal für die API erstellen

Sie können mit dem Cloud Endpoints-Portal ein Entwicklerportal erstellen. Das ist eine Website zur Interaktion mit der Beispiel-API. Weitere Informationen finden Sie unter Übersicht über das Cloud Endpoints-Portal.

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die auf dieser Seite verwendeten Ressourcen in Rechnung gestellt werden:

Informationen zum Beenden der in dieser Anleitung verwendeten Dienste finden Sie unter API und API-Instanzen löschen.