Erste Schritte mit Cloud Endpoints für verwaltete Instanzgruppen (MIGs) mit ESPv2

In dieser Anleitung wird erklärt, wie Sie eine Beispiel-API und den Extensible Service Proxy V2 (ESPv2), der in vordefinierten Docker-Containern ausgeführt wird, konfigurieren und in Verwaltete Instanzgruppe (MIGs) bereitstellen.

Die REST API des Beispielcodes wird mit der OpenAPI-Spezifikation beschrieben. Sie erfahren außerdem, wie Sie einen API-Schlüssel erstellen und in Anfragen an die API verwenden.

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

Ziele

Orientieren Sie sich beim Durcharbeiten der Anleitung an der folgenden Aufgabenliste. Alle Aufgaben sind erforderlich, um Anfragen sicher an die API senden zu können.

  1. Richten Sie ein Google Cloud-Projekt ein. Siehe Vorbereitung.
  2. Beispielcode herunterladen: Siehe Beispielcode abrufen.
  3. Konfigurieren Sie die Datei openapi.yaml, mit der Endpoints konfiguriert wird. Siehe Endpoints konfigurieren.
  4. Die Endpoints-Konfiguration bereitstellen, um einen Endpoints-Dienst zu erstellen: Siehe Endpoints-Konfiguration bereitstellen.
  5. Stellen Sie die API und ESPv2 im Backend der verwalteten Instanzgruppe (Managed Instance Group, MIGs) bereit. Siehe API-Backend bereitstellen.
  6. Über eine IP-Adresse eine Anfrage an die API senden: Siehe Anfrage über eine IP-Adresse senden.
  7. Einen DNS-Eintrag für die Beispiel-API konfigurieren: Siehe DNS für Endpoints konfigurieren.
  8. Unter Verwendung des vollständig qualifizierten Domainnamens eine Anfrage an die API senden: Siehe Anfrage über FQDN senden.
  9. API-Aktivitäten verfolgen: Siehe API-Aktivitäten verfolgen.
  10. 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.

Hinweis

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Notieren Sie sich die Projekt-ID, da sie später benötigt wird.

  7. Sie benötigen eine Anwendung, um Anfragen an die Beispiel-API zu senden.

    • Nutzer von Linux und macOS: Diese Anleitung enthält ein Beispiel, bei dem curl verwendet wird. Das Tool ist normalerweise auf Ihrem Betriebssystem vorinstalliert. Wenn curl nicht installiert ist, können Sie es von der Seite Releases und Downloads für curl herunterladen.
    • Nutzer von Windows: Diese Anleitung enthält ein Beispiel, bei dem Invoke-WebRequest verwendet wird. Der Befehl wird in PowerShell ab Version 3.0 unterstützt.
  8. Laden Sie die Google Cloud CLI herunter.
  9. gcloud CLI aktualisieren und Endpoints installieren Komponenten. 
    gcloud components update
  10. Die Google Cloud CLI (gcloud) muss zum Zugriff berechtigt sein Ihre Daten und Dienste in Google Cloud: 
    gcloud auth login
     Ein neuer Browsertab wird geöffnet. Wählen Sie dort ein Konto aus.
  11. Legen Sie für das Standardprojekt Ihre Projekt-ID fest: 
    gcloud config set project YOUR_PROJECT_ID

    Ersetzen Sie YOUR_PROJECT_ID durch Ihre Projekt-ID. Wenn Sie weitere Google Cloud-Projekte haben und gcloud verwenden möchten finden Sie unter gcloud CLI-Konfigurationen verwalten

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.

Beispielcode herunterladen

Laden Sie den Beispielcode auf Ihren lokalen Rechner herunter.

Java

So klonen Sie die Beispiel-API oder laden diese herunter:

  1. Klonen Sie das Repository der Beispiel-App auf Ihren lokalen Computer: 
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd java-docs-samples/endpoints/getting-started
Python

So klonen Sie die Beispiel-API oder laden diese herunter:

  1. Klonen Sie das Repository der Beispiel-App auf Ihren lokalen Computer: 
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd python-docs-samples/endpoints/getting-started
Go

So klonen Sie die Beispiel-API oder laden diese herunter:

  1. Prüfen Sie, ob die Umgebungsvariable GOPATH festgelegt ist.
  2. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

So klonen Sie die Beispiel-API oder laden diese herunter:

  1. Klonen Sie das Repository der Beispiel-App auf Ihren lokalen Computer: 
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd php-docs-samples/endpoints/getting-started
Ruby

So klonen Sie die Beispiel-API oder laden diese herunter:

  1. Klonen Sie das Repository der Beispiel-App auf Ihren lokalen Computer: 
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd ruby-docs-samples/endpoints/getting-started
NodeJS

So klonen Sie die Beispiel-API oder laden diese herunter:

  1. Klonen Sie das Repository der Beispiel-App auf Ihren lokalen Computer: 
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd nodejs-docs-samples/endpoints/getting-started

Endpoints konfigurieren

Der Beispielcode enthält die OpenAPI-Konfigurationsdatei openapi.yaml, die auf der OpenAPI-Spezifikation Version 2.0 beruht. Konfigurieren Sie die Datei openapi.yaml und stellen Sie sie auf Ihrem lokalen Rechner bereit. So konfigurieren Sie Endpoints:

  1. Öffnen Sie im Verzeichnis mit dem Beispielcode die Konfigurationsdatei openapi.yaml.

    Java
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Python
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Go
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    PHP
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Ruby
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    NodeJS
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

    Wichtige Hinweise:

    • Im Konfigurationsbeispiel sind die Zeilen in der Nähe des Feldes host zu sehen, die Sie ändern müssen. Zum Bereitstellen der Datei openapi.yaml für Endpoints ist das vollständige OpenAPI-Dokument erforderlich.
    • Die Beispieldatei openapi.yaml enthält einen Abschnitt zum Konfigurieren der Authentifizierung, der für diese Anleitung nicht benötigt wird. Die Zeilen mit YOUR-SERVICE-ACCOUNT-EMAIL und YOUR-CLIENT-ID müssen Sie nicht konfigurieren.
    • OpenAPI ist eine sprachunabhängige Spezifikation. Die Datei openapi.yaml für das Beispiel getting-started ist im GitHub-Repository aller Sprachen die gleiche.

  2. Ersetzen Sie im Feld host den Text durch den Namen des Endpoints-Diensts. Er sollte das folgende Format haben:
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

    Ersetzen Sie YOUR_PROJECT_ID durch Ihre Google Cloud-Projekt-ID. Beispiel:

    host: "echo-api.endpoints.example-project-12345.cloud.goog"

echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog ist der Name des Endpoints-Diensts. Sie verwenden nicht den vollständig qualifizierten Domainnamen (FQDN) zum Senden von Anfragen an die API.

Informationen zu den Feldern im OpenAPI-Dokument, die für Endpoints erforderlich sind, finden Sie unter Endpoints konfigurieren. Wenn Sie die folgenden Konfigurationsschritte durchgeführt haben und Anfragen erfolgreich über eine IP-Adresse an die Beispiel-API senden können, erfahren Sie unter DNS für Endpoints konfigurieren, wie echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog als FQDN konfiguriert wird.

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:

  1. Sie müssen sich im Verzeichnis endpoints/getting-started befinden.
  2. Laden Sie die Konfiguration hoch und erstellen Sie einen verwalteten Dienst:
    gcloud endpoints services deploy openapi.yaml

Der Befehl gcloud ruft dann die Service Management API auf, um einen verwalteten Dienst mit dem Namen zu erstellen, den Sie im Feld host der Datei openapi.yaml angegeben haben. In der Service Management API wird der Dienst gemäß den Einstellungen in der Datei openapi.yaml konfiguriert. Wenn Sie Änderungen an openapi.yamlopenapi.yaml vornehmen, müssen Sie die Datei noch einmal bereitstellen, um den Endpoints-Dienst zu aktualisieren.

Beim Erstellen und Konfigurieren des Dienstes gibt Service Management Informationen an das Terminal aus. Warnungen mit dem Hinweis, dass für die Pfade in der Datei openapi.yaml kein API-Schlüssel erforderlich ist, können Sie ignorieren. Nach Abschluss der Dienstkonfiguration wird von Service Management eine Meldung mit der Dienstkonfigurations-ID und dem Dienstnamen angezeigt, die etwa so aussieht:

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

Im vorherigen Beispiel ist 2017-02-13r0 die Dienstkonfigurations-ID und echo-api.endpoints.example-project-12345.cloud.goog der Name des Endpoints-Dienstes. Die Dienstkonfigurations-ID besteht aus einem Datumsstempel und einer Überarbeitungsnummer. Wenn Sie die Datei openapi.yaml am selben Tag noch einmal bereitstellen, erhöht sich die Überarbeitungsnummer in der Dienstkonfigurations-ID. Sie können die Endpoints-Dienstkonfiguration in der Google Cloud Console auf der Seite Endpoints > Dienste aufrufen.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie Fehlerbehebung bei der Endpoints-Konfigurationsbereitstellung.

Erforderliche Dienste prüfen

Für Endpoints und 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 dem Bereitstellen der Endpoints-Konfiguration in der Cloud Console die Seite Endpunkte 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.

API-Backend bereitstellen

Instanzvorlage erstellen

Erstellen Sie eine Vorlage, um damit eine Gruppe von VM-Instanzen zu erstellen. Jede aus der Vorlage erstellte Instanz startet einen ESPv2 und einen Backend-Anwendungsserver.

  1. Rufen Sie in der Google Cloud Console die Seite Instanzvorlagen auf.

    Zu Instanzvorlagen

  2. Klicken Sie auf Instanzvorlage erstellen.

  3. Geben Sie für Name load-balancing-espv2-template ein.

  4. Legen Sie unter Maschinenkonfiguration den Maschinentyp auf e2-micro fest.

  5. Legen Sie unter Bootlaufwerk das Image auf Container Optimized OS stable version fest.

  6. Wählen Sie unter Firewall die Option HTTP-Traffic zulassen aus.

  7. Klicken Sie auf Verwaltung, Sicherheit, Laufwerke, Netzwerke, Einzelne Mandanten, um die erweiterten Einstellungen einzublenden.

  8. Klicken Sie auf den Tab Verwaltung. Geben Sie unter Automatisierung folgendes Startskript ein: Denken Sie daran, ENDPOINTS_SERVICE_NAME zu aktualisieren.

    sudo docker network create --driver bridge esp_net
sudo docker run \
  --detach \
  --name=echo \
  --net=esp_net \
  gcr.io/google-samples/echo-python:1.0
sudo docker run \
  --detach \
  --name=esp \
  --publish=80:9000 \
  --net=esp_net \
  gcr.io/endpoints-release/endpoints-runtime:2 \
  --service=ENDPOINTS_SERVICE_NAME \
  --rollout_strategy=managed \
  --listener_port=9000 \
  --healthz=/healthz \
  --backend=echo:8080

    Das Skript ruft den Echo-Anwendungsserver und den ESPv2-Proxyserver beim Start der Instanz ab, installiert diese Elemente und startet sie.

  9. Klicken Sie auf Erstellen.

Warten Sie, bis die Vorlage erstellt ist, bevor Sie fortfahren.

Regionale verwaltete Instanzgruppe erstellen

Verwenden Sie zum Ausführen der Anwendung die Instanzvorlage, um eine regionale, verwaltete Instanzgruppe zu erstellen:

  1. Rufen Sie in der Google Cloud Console die Seite Instanzgruppen auf.

    Zu den Instanzgruppen

  2. Klicken Sie auf Instanzgruppe erstellen.

  3. Geben Sie für Name load-balancing-espv2-group ein.

  4. Wählen Sie unter Standort die Option Mehrere Zonen aus.

  5. Wählen Sie unter Region die Option us-central1 aus.

  6. Klicken Sie auf das Drop-down-Menü Zonen konfigurieren, um Zonen einzublenden. Wählen Sie die folgenden Zonen aus:

    • us-central1-b
    • us-central1-c
    • us-central1-f

  7. Wählen Sie unter Instanzvorlage load-balancing-espv2-template aus.

  8. Wählen Sie unter Autoscaling die Option Kein Autoscaling aus.

  9. Legen Sie Anzahl der Instanzen auf 3 fest.

  10. Wählen Sie unter Weiterverteilung von Instanzen die Option Ein aus.

  11. Wählen Sie unter Automatische Reparatur und Systemdiagnose die Option Keine Systemdiagnose aus.

  12. Klicken Sie auf Erstellen. Damit kehren Sie wieder zur Seite Instanzgruppen zurück.

Load-Balancer erstellen

Dieser Abschnitt erläutert die Schritte zum Erstellen eines globalen Load-Balancers, der HTTP-Traffic an die Instanzgruppe weiterleitet.

Dieser Load-Balancer verwendet ein Frontend, um eingehenden Traffic zu empfangen, und ein Backend, um diesen Traffic auf fehlerfreie Instanzen zu verteilen. Da der Load-Balancer aus mehreren Komponenten besteht, gliedert sich diese Aufgabe in mehrere Teile:

  • Back-end-Konfiguration
  • Frontend-Konfiguration
  • Prüfen und abschließen

Führen Sie zum Erstellen des Load-Balancers alle Schritte aus.

  1. Rufen Sie in der Google Cloud Console die Seite Load-Balancer erstellen auf.

    Zur Seite „Load-Balancer erstellen”

  2. Klicken Sie im Abschnitt Anwendungs-Load-Balancer (HTTP/S) auf Konfiguration starten.

  3. Wählen Sie unter Internet oder nur intern die Option Vom Internet zu meinen VMs aus. Klicken Sie dann auf Weiter.

  4. Geben Sie espv2-load-balancer als Namen für den Load-Balancer ein.

Backend-Konfiguration

  1. Klicken Sie im linken Bereich der Seite Globalen externen Anwendungs-Load-Balancer erstellen auf Backend-Konfiguration.
  2. Klicken Sie auf Backend-Dienste und Backend-Buckets erstellen oder auswählen, um ein Drop-down-Menü zu öffnen. Klicken Sie auf Back-End-Dienste und dann auf Back-End-Dienst erstellen.
  3. Geben Sie im neuen Fenster als Name der Back-End-Anwendung den String espv2-backend ein.
  4. Legen Sie Instanzgruppe auf load-balancing-espv2-group fest.
  5. Legen Sie für Portnummern den Wert 80 fest. Damit wird HTTP-Traffic zwischen dem Load-Balancer und der Instanzgruppe zugelassen.
  6. Wählen Sie unter Balancing-Modus die Option Auslastung aus.
  7. Klicken Sie auf Fertig, um das Back-End zu erstellen.

  8. Erstellen Sie die Systemdiagnose für das Back-End des Load Balancers:

    1. Wählen Sie unter Systemdiagnose die Option Systemdiagnose erstellen (oder Weitere Systemdiagnose erstellen) aus dem Drop-down-Menü aus. Ein neues Fenster wird geöffnet.
    2. Geben Sie im neuen Fenster unter Name den String espv2-load-balancer-check ein.
    3. Legen Sie als Protokoll HTTP fest.
    4. Geben Sie für Port den Wert 80 ein.
    5. Legen Sie den Anfragepfad für diese Anleitung auf /healthz fest. Dies ist ein Pfad, auf den der ESPv2 reagiert.

    6. Legen Sie die folgenden Diagnosekriterien fest:

      1. Legen Sie Überprüfungsintervall auf 3 Sekunden fest. Dies definiert die Zeitspanne vom Start einer Prüfung bis zum Start der nächsten.
      2. Legen Sie Zeitlimit auf 3 Sekunden fest. Damit wird definiert, wie lange die Google Cloud bei einer Prüfung auf eine Antwort wartet. Der Wert muss kleiner oder gleich dem Überprüfungsintervall sein.
      3. Legen Sie den Schwellenwert für Intaktheit auf 2 aufeinanderfolgende Erfolge fest. Dies definiert die Anzahl der sequenziellen Prüfungen, die erfolgreich verlaufen müssen, damit eine Instanz als intakt erachtet wird.
      4. Setzen Sie Fehlerschwellenwert auf 2 aufeinanderfolgende Fehler fest. Dies definiert die Anzahl der sequenziellen Prüfungen, die fehlschlagen müssen, damit eine Instanz als nicht intakt erachtet wird.

    7. Klicken Sie auf Speichern und fortfahren, um die Systemdiagnose zu erstellen.

  9. Klicken Sie auf Create (Erstellen), um den Back-End-Dienst zu erstellen.

Frontend-Konfiguration

  1. Klicken Sie im linken Bereich der Seite Globalen externen Application Load Balancer erstellen auf Frontend-Konfiguration.
  2. Geben Sie auf der Seite Frontend-Konfiguration unter Name den String espv2-ipv4-frontend ein.
  3. Legen Sie als Protokoll HTTP fest.
  4. Legen Sie als Port 80 fest.
  5. Klicken Sie auf Fertig, um das Frontend zu erstellen.

Prüfen und abschließen

  1. Prüfen Sie die Load-Balancing-Einstellungen, bevor Sie den Load-Balancer erstellen:

    1. Klicken Sie im linken Bereich der Seite Globalen externen Application Load Balancer erstellen auf Prüfen und abschließen.

    2. Prüfen Sie auf der Seite Prüfen und abschließen, ob die folgenden Einstellungen für das Backend vorliegen:

      • Der Back-End-Dienst ist espv2-backend.
      • Das Endpunktprotokoll ist HTTP.
      • Die Systemdiagnose ist espv2-load-balancer-check.
      • Die Instanzgruppe ist load-balancing-espv2-group.

    3. Prüfen Sie auf derselben Seite, ob das Frontend eine IP-Adresse mit dem Protokoll HTTP verwendet.

  2. Klicken Sie im linken Bereich der Seite Globalen externen Application Load Balancer erstellen auf Erstellen, um den Load Balancer fertigzustellen.

    Möglicherweise müssen Sie einige Minuten warten, bis der Load-Balancer erstellt wurde.

  3. Suchen Sie nach der Erstellung des Load-Balancers auf der Seite Load-Balancer die IP-Adresse.

    Load-Balancer aufrufen

Anfrage über eine IP-Adresse senden

Sobald die Beispiel-API und ESPv2 auf dem bereitgestellten Backend ausgeführt werden, können Sie Anfragen an die API senden.

API-Schlüssel erstellen und Umgebungsvariable festlegen

Für den Beispielcode ist ein API-Schlüssel erforderlich. Zur Vereinfachung der Anfrage legen Sie eine Umgebungsvariable für den API-Schlüssel fest.

  1. Erstellen Sie in dem Google Cloud-Projekt, das Sie für Ihre API verwendet haben, auf der Seite mit den API-Anmeldedaten einen API-Schlüssel. Informationen zum Erstellen eines API-Schlüssels in einem anderen Google Cloud-Projekt finden Sie unter API im Google Cloud-Projekt aktivieren.

    Zur Seite "Domainbestätigung"

  2. Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus.
  3. Kopieren Sie den Schlüssel in die Zwischenablage.
  4. Klicken Sie auf Schließen.
  5. Fügen Sie den API-Schlüssel auf Ihrem lokalen Computer ein, um ihn einer Umgebungsvariable zuzuweisen:
    • In Linux oder macOS: export ENDPOINTS_KEY=AIza...
    • In Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Anfrage senden

Linux oder macOS

Senden Sie mit curl eine HTTP-Anfrage unter Verwendung der zuvor festgelegten Umgebungsvariablen ENDPOINTS_KEY. Ersetzen Sie IP_ADDRESS durch die externe IP-Adresse Ihrer Instanz.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

Im vorherigen Beispiel für curl gilt:

  • Durch die Option --data werden die an die API zu übertragenden Daten festgelegt.
  • Durch die Option --header wird angegeben, dass die Daten im JSON-Format vorliegen.

PowerShell

Senden Sie mit Invoke-WebRequest eine HTTP-Anfrage unter Verwendung der zuvor festgelegten Umgebungsvariablen ENDPOINTS_KEY. Ersetzen Sie IP_ADDRESS durch die externe IP-Adresse Ihrer Instanz.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").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 eine Drittanbieteranwendung wie die Chrome-Browsererweiterung Postman zum Senden der Anfrage verwenden:

  • Wählen Sie POST als HTTP-Verb aus.
  • Wählen Sie für den Header den Schlüssel content-type und den Wert application/json aus.
  • Geben Sie als Text Folgendes ein:
    {"message":"hello world"}
  • Verwenden Sie in der URL den tatsächlichen API-Schlüssel und nicht die Umgebungsvariable. Beispiel:
    http://192.0.2.0:80/echo?key=AIza...

Die API gibt die von Ihnen gesendete Meldung zurück und reagiert mit folgender Zeile:

{
  "message": "hello world"
}

Wenn Sie als Antwort einen Fehler erhalten haben, lesen Sie die Informationen unter Fehlerbehebung bei Antwortfehlern.

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

DNS für Endpoints konfigurieren

Da sich der Name des Endpoints-Diensts für die API in der Domain .endpoints.YOUR_PROJECT_ID.cloud.goog befindet, können Sie ihn als vollständig qualifizierten Domainnamen verwenden. Dazu nehmen Sie eine kleine Konfigurationsänderung in Ihrer openapi.yaml -Datei vor. Sie können dadurch Anfragen an die Beispiel-API über echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog senden, anstatt die IP-Adresse zu verwenden.

So konfigurieren Sie das DNS für Endpoints:

  1. Öffnen Sie die OpenAPI-Konfigurationsdatei openapi.yaml und fügen Sie das Attribut x-google-endpoints wie im folgenden Snippet gezeigt auf der obersten Ebene der Datei hinzu (nicht eingerückt oder verschachtelt):
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
  target: "IP_ADDRESS"
  2. Ersetzen Sie im Attribut name den Parameter YOUR_PROJECT_ID durch Ihre Projekt-ID.
  3. Ersetzen Sie im Attribut target den Parameter IP_ADDRESS durch die IP-Adresse, die Sie beim Senden einer Anfrage an die Beispiel-API verwendet haben.
  4. Stellen Sie Ihre aktualisierte OpenAPI-Konfigurationsdatei für Service Management bereit:
    gcloud endpoints services deploy openapi.yaml

Beispiel: In der Datei openapi.yaml ist Folgendes konfiguriert:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Wenn Sie die Datei openapi.yaml mit dem vorherigen gcloud-Befehl bereitstellen, wird in der Service Management API der DNS-A-Eintrag echo-api.endpoints.my-project-id.cloud.goog erstellt und in die Ziel-IP-Adresse 192.0.2.1 aufgelöst. Es kann einige Minuten dauern, bis die neue DNS-Konfiguration verteilt wurde.

SSL konfigurieren

Weitere Informationen zum Konfigurieren von DNS und SSL finden Sie unter SSL für Endpoints aktivieren.

Anfrage über FQDN senden

Sie haben den DNS-Eintrag für die Beispiel-API konfiguriert. Nun senden Sie eine Anfrage über den FQDN (ersetzen Sie dabei YOUR_PROJECT_ID durch Ihre Projekt-ID) und die zuvor festgelegte Umgebungsvariable ENDPOINTS_KEY:
  • In Linux oder macOS:
    curl --request POST \
    --header "content-type:application/json" \
    --data '{"message":"hello world"}' \
    "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"
  • In Windows PowerShell:
    (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

API-Aktivität nachverfolgen

So verfolgen Sie API-Aktivitäten:

  1. Sehen Sie sich auf der Seite Endpoints > Dienste die Aktivitätsgrafiken für Ihre API an.

    Endpoints-Dienste aufrufen


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

    Zur Seite „Log-Explorer“

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

Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, löschen Sie entweder das Projekt, das die Ressourcen enthält, oder Sie behalten das Projekt und löschen die einzelnen Ressourcen.

  1. Die gcloud CLI (gcloud) muss berechtigt sein, auf Ihre Daten und Dienste in Google Cloud zuzugreifen:

    gcloud auth login

  2. Geben Sie Folgendes ein, um sich die Projekt-IDs für Ihre Google Cloud-Projekte anzeigen zu lassen:

    gcloud projects list

  3. Verwenden Sie die entsprechende Projekt-ID aus dem vorherigen Schritt, um das Google Cloud-Standardprojekt auf das Projekt festzulegen, in dem sich Ihre Anwendung befindet:

    gcloud config set project [YOUR_PROJECT_ID]

  4. Ermitteln Sie den Namen aller verwalteten Dienste in Ihrem Google Cloud-Projekt:

    gcloud endpoints services list

  5. Löschen Sie den Dienst aus Service Management. Ersetzen Sie dabei SERVICE_NAME durch den Namen des Dienstes, den Sie entfernen möchten:

    gcloud endpoints services delete SERVICE_NAME

    Der verwaltete Dienst wird bei Ausführung von gcloud endpoints services delete nicht sofort gelöscht. Service Management deaktiviert den verwalteten Dienst 30 Tage lang, sodass Sie ihn bei Bedarf wiederherstellen können. Nach 30 Tagen löscht Service Management den verwalteten Dienst endgültig.

  6. Rufen Sie die Seite Load-Balancer auf.

    Load-Balancer aufrufen

    Löschen Sie den Load-Balancer espv2-load-balancer mit dem Backend-Dienst espv2-backend und der Systemdiagnose espv2-load-balancer-check.

  7. Gehen Sie zu der Seite Instanzgruppen.

    Zu den Instanzgruppen

    load-balancing-espv2-group löschen

  8. Gehen Sie zur Seite Instanzvorlage.

    Instanzvorlagen aufrufen

    load-balancing-espv2-template löschen.

Nächste Schritte