Erste Schritte mit Cloud Endpoints für Compute Engine mit ESP

In dieser Anleitung wird erklärt, wie Sie eine Beispiel-API und den Extensible Service Proxy (ESP) zur Ausführung in vordefinierten Docker-Containern in Compute Engine konfigurieren und 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 Endpoints-Architektur.

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. Erstellen Sie eine Compute Engine-VM-Instanz. Siehe Compute Engine-Instanz erstellen.
  3. Laden Sie den Beispielcode herunter. Siehe Beispielcode abrufen.
  4. Konfigurieren Sie die Datei openapi.yaml, mit der Endpoints konfiguriert wird. Siehe Endpoints konfigurieren.
  5. Stellen Sie die Endpoints-Konfiguration bereit, um einen Endpoints-Dienst zu erstellen. Siehe Endpoints-Konfiguration bereitstellen.
  6. Stellen Sie die API und den ESP auf der Compute Engine-VM bereit. Siehe API-Back-End bereitstellen.
  7. Senden Sie über eine IP-Adresse eine Anfrage an die API. Siehe Anfrage über eine IP-Adresse senden.
  8. Konfigurieren Sie einen DNS-Eintrag für die Beispiel-API. Siehe DNS für Endpoints konfigurieren.
  9. Senden Sie unter Verwendung des vollständig qualifizierten Domainnamens eine Anfrage an die API. Siehe Anfrage über FQDN senden.
  10. Verfolgen Sie die API-Aktivitäten. Siehe API-Aktivitäten verfolgen.
  11. Vermeiden Sie Gebühren, die Ihrem Google Cloud-Konto in Rechnung gestellt werden. Siehe Bereinigen.

Kosten

In dieser Anleitung werden die folgenden kostenpflichtigen Komponenten von Google Cloud verwendet:

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 dieser Anleitung können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Hinweise

  1. Melden Sie sich bei Ihrem Google-Konto an.

    Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.

  2. Wählen Sie in der Cloud Console auf der Seite für die Projektauswahl ein Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  3. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für Ihr Projekt aktiviert ist.

  4. Notieren Sie sich die Projekt-ID, da sie später benötigt wird.
  5. 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.
  6. Laden Sie das Cloud SDK herunter.
  7. Aktualisieren Sie das Cloud SDK und installieren Sie die Endpoints-Komponenten.
    gcloud components update
  8. Das Cloud SDK (gcloud) muss berechtigt sein, auf Ihre Daten und Dienste auf Google Cloud zuzugreifen:
    gcloud auth login
    Ein neuer Browsertab wird geöffnet. Wählen Sie dort ein Konto aus.
  9. 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 mit gcloud verwalten möchten, lesen Sie Cloud SDK-Konfigurationen verwalten.

Nach Abschluss dieser Anleitung können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Compute Engine-Instanz erstellen

    So erstellen Sie eine Compute Engine-Instanz:

    1. Öffnen Sie in der Cloud Console die Seite VM-Instanzen.

      Zur Seite "VM-Instanzen"

    2. Klicken Sie auf Instanz erstellen.
    3. Wählen Sie im Bereich Firewall die Option HTTP-Traffic zulassen und HTTPS-Traffic zulassen.
    4. Klicken Sie auf Erstellen, um die Instanz anzulegen.
    5. Screenshot des Fensters zum Erstellen von VM-Instanzen mit den erforderlichen Optionen

      Warten Sie, bis die Instanz gestartet ist. Anschließend wird sie auf der Seite der VM-Instanzen mit einem grünen Statussymbol angezeigt.

    6. Bestätigen Sie, dass Sie eine Verbindung zu Ihrer VM-Instanz herstellen können.
      1. Klicken Sie in der Liste der VM-Instanzen in der Zeile der Instanz, zu der Sie eine Verbindung herstellen möchten, auf SSH.
      2. Sie können jetzt über das Terminal Linux-Befehle auf Ihrer Debian-Instanz ausführen.
      3. Geben Sie exit ein, um die Verbindung zur Instanz zu trennen.
    7. Notieren Sie den Instanznamen, die Zone und die externe IP-Adresse, da sie später benötigt werden.

Beispielcode herunterladen

Laden Sie den Beispielcode auf Ihren lokalen Rechner herunter.

Java

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung 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 können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung 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 können Sie die Beispiel-API klonen oder herunterladen:

  1. Prüfen Sie, ob die Umgebungsvariable GOPATH festgelegt ist.
  2. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    go get -u -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 können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung 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 können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung 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 können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung 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 basiert. 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.

    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 Cloud Console auf der Seite Endpoints > Dienste aufrufen.

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

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 der Bereitstellung der Endpoints-Konfiguration die Seite Endpoints 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.

API-Back-End bereitstellen

Bisher haben Sie das OpenAPI-Dokument für Service Management bereitgestellt, den Code für das API-Back-End jedoch noch nicht implementiert. In diesem Abschnitt erfahren Sie, wie Sie Docker für Ihre VM-Instanz einrichten und den API-Backend-Code sowie den ESP in einem Docker-Container ausführen.

Erforderliche Berechtigungen prüfen

  • Öffnen Sie in der Cloud Console die Seite "Compute Engine-Instanzen".

    Zur Seite "Compute Engine"

  • Wählen Sie Ihre Instanz aus der Liste aus.
  • Sie sehen das zugehörige Dienstkonto und die zugehörigen Berechtigungen.
  • Gewähren Sie Berechtigungen für das Dienstkonto.

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

    Weitere Informationen finden Sie unter Was sind Rollen und Berechtigungen?

Docker auf der VM-Instanz installieren

So installieren Sie Docker auf der VM-Instanz:

  1. Legen Sie mit dem folgenden Befehl die Zone für Ihr Projekt fest:
    gcloud config set compute/zone YOUR_INSTANCE_ZONE
    

    Ersetzen Sie YOUR_INSTANCE_ZONE durch die Zone, in der die Instanz ausgeführt wird.

  2. Stellen Sie mit dem folgenden Befehl eine Verbindung zu Ihrer Instanz her:
    gcloud compute ssh INSTANCE_NAME
    

    Ersetzen Sie INSTANCE_NAME durch den Namen Ihrer VM-Instanz.

  3. Richten Sie anhand der Docker-Dokumentation das Docker-Repository ein. Folgen Sie dabei den Anleitungen für die Version und Architektur Ihrer VM-Instanz:
    • Jessie oder neuer
    • x86_64/amd64

Beispiel-API und ESP in einem Docker-Container ausführen

Der ESP ist ein nginx-basierter Proxy, der vor Ihrem Back-End-Code implementiert wird. Er verarbeitet eingehenden Traffic und führt die Authentifizierung, die API-Schlüsselverwaltung, das Logging und weitere Endpoints API-Verwaltungsfunktionen aus.

So installieren Sie die Beispiel-API und den ESP in einem Docker-Container oder führen sie aus:

  1. Erstellen Sie Ihr eigenes Container-Netzwerk mit dem Namen esp_net.
    sudo docker network create --driver bridge esp_net
    
  2. Führen Sie den Echo-Beispielserver aus, der die Beispiel-API bereitstellt:
    Java
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-java:1.0
    
    Python
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-python:1.0
    
    Go
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-go:1.0
    
    PHP
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-php:1.0
    
    Ruby
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-ruby:1.0
    
    NodeJS
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-node:1.0
    
  3. Führen Sie den vorkonfigurierten ESP-Docker-Container aus. Ersetzen Sie in den ESP-Startoptionen SERVICE_NAME durch den Namen Ihres Diensts. Dies ist der Name, den Sie im Feld host Ihres OpenAPI-Dokuments konfiguriert haben.
    sudo docker run \
        --name=esp \
        --detach \
        --publish=80:8080 \
        --net=esp_net \
        gcr.io/endpoints-release/endpoints-runtime:1 \
        --service=SERVICE_NAME \
        --rollout_strategy=managed \
        --backend=echo:8080
    

    Mit der Option --rollout_strategy=managed legen Sie fest, dass der ESP die zuletzt bereitgestellte Dienstkonfiguration verwendet. Wenn Sie diese Option innerhalb von 5 Minuten nach der Bereitstellung einer neuen Dienstkonfiguration angeben, erkennt der ESP die Änderung und verwendet automatisch die neue Konfiguration. Wir empfehlen, diese Option anstelle einer konkreten Konfigurations-ID anzugeben, die vom ESP verwendet werden soll. Informationen zu den oben verwendeten ESP-Optionen finden Sie unter ESP-Startoptionen.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie die Informationen unter Fehlerbehebung bei Endpoints auf Compute Engine.

Weitere Informationen finden Sie unter API-Back-End bereitstellen.

Anfrage über eine IP-Adresse senden

Sobald die Beispiel-API und der ESP auf der Compute Engine-Instanz 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 "Anmeldedaten"

  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.

    Zur Seite "Endpoints-Dienste"

    }
    Es kann einige Momente dauern, bis die Anfrage in den Grafiken angezeigt wird.

  2. Sehen Sie sich auf der Seite "Loganzeige" die Anfragelogs an.

    Loganzeige aufrufen

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

So vermeiden Sie, dass Ihrem Google Cloud Platform-Konto die in dieser Anleitung verwendeten Ressourcen in Rechnung gestellt werden:

  1. Löschen Sie die API:
    gcloud endpoints services delete SERVICE_NAME
    

    Ersetzen Sie SERVICE_NAME durch den Namen Ihres Diensts.

  2. Öffnen Sie in der Cloud Console die Seite VM-Instanzen.

    Zur Seite "VM-Instanzen"

  3. Klicken Sie auf das Kästchen für die Instanz, die Sie löschen möchten.
  4. Klicken Sie auf Löschen , um die Instanz zu löschen.

Weitere Informationen