In dieser Anleitung wird beschrieben, wie Sie eine Beispiel-API und den Extensible Service Proxy V2 (ESPv2) für einen Google Kubernetes Engine-Cluster (GKE) konfigurieren und bereitstellen.
Die REST API des Beispielcodes wird in der OpenAPI-Spezifikation beschrieben. Sie erfahren außerdem, wie Sie einen API-Schlüssel erstellen und beim Senden von Anfragen an die API verwenden.
In der Anleitung werden vorkonfigurierte Container-Images des Beispielcodes und des ESPv2 verwendet, die in Container Registry gespeichert sind.
Eine Übersicht über Cloud Endpoints finden Sie in den Abschnitten Über Cloud Endpoints und Architekturübersicht zu Cloud Endpoints.
Ziele
Beim Durcharbeiten der Anleitung können Sie sich an der folgenden Aufgabenliste orientieren. Alle Aufgaben in Teil 1 sind erforderlich, um Anfragen an die API zu senden.
Teil 1
- Richten Sie ein Google Cloud-Projekt ein. Siehe Vorbereitung.
- In GKE einen Container-Cluster erstellen. Siehe Container-Cluster erstellen.
- Die in der Anleitung verwendete Software installieren und konfigurieren. Siehe Erforderliche Software installieren und konfigurieren.
- Den Beispielcode herunterladen. Siehe Beispielcode abrufen.
- Konfigurieren Sie die Datei
openapi.yaml
, mit der Cloud Endpoints konfiguriert wird. Siehe Endpoints konfigurieren. - Die Endpoints-Konfiguration bereitstellen, um einen Endpoints-Dienst zu erstellen. Siehe Endpoints-Konfiguration bereitstellen.
- Stellen Sie die API und den ESPv2 im Cluster bereit. Siehe API-Back-End bereitstellen.
- Externe IP-Adresse des Clusters abrufen. Siehe Externe IP-Adresse des Clusters abrufen.
- Über eine IP-Adresse eine Anfrage an die API senden. Siehe Anfrage über eine IP-Adresse senden.
- API-Aktivitäten verfolgen. Siehe API-Aktivitäten verfolgen.
Teil 2
- Einen DNS-Eintrag für die Beispiel-API konfigurieren. Siehe DNS für Endpoints konfigurieren.
- Senden Sie mit einem vollständig qualifizierten Domainnamen eine Anfrage an die API. Siehe Anfrage über FQDN senden.
Clean-up
Wenn Sie fertig sind, lesen Sie den Abschnitt Bereinigen, um Gebühren für Ihr Google Cloud-Konto zu vermeiden.
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
-
Melden Sie sich bei Ihrem Google-Konto an.
Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.
-
Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.
-
Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für Ihr Projekt aktiviert ist.
- Notieren Sie sich die Google Cloud-Projekt-ID, da sie später benötigt wird.
Containercluster erstellen
Sie müssen in GKE einen Container-Cluster erstellen und einrichten, in dem der API-Back-End-Beispielcode ausgeführt wird. So erstellen Sie einen Containercluster für die Beispiel-API:
- Öffnen Sie in der Google Cloud Console die Seite zu den GKE-Clustern.
- Klicken Sie auf Cluster erstellen.
- Übernehmen Sie die Standardwerte und klicken Sie auf Erstellen. Dies kann einige Minuten dauern.
- Notieren Sie sich den Namen und die Zone des Clusters, da beides für die Authentifizierung von
kubectl
für den Container-Cluster benötigt wird.
Erforderliche Software installieren und konfigurieren
Mithilfe dieser Anleitung installieren Sie das Cloud SDK, um die gcloud
-Befehlszeilenschnittstelle zum Verwalten Ihres Projekts verwenden zu können.
Mit kubectl
führen Sie Befehle für GKE-Cluster aus. Sie müssen außerdem die API testen können.
Wenn Sie die erforderliche Software bereits installiert haben, können Sie mit dem nächsten Schritt fortfahren.
So installieren und konfigurieren Sie die erforderliche Software:
-
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. Wenncurl
nicht installiert ist, können Sie es von der Seite Releases und Downloads fürcurl
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.
- Nutzer von Linux und macOS: Diese Anleitung enthält ein Beispiel, bei dem
- Installieren und initialisieren Sie das Cloud SDK.
- Aktualisieren Sie das Cloud SDK und installieren Sie die Endpoints-Komponenten:
gcloud components update
- 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. -
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 SDK-Konfigurationen verwalten. - Installieren Sie
kubectl
:gcloud components install kubectl
-
Rufen Sie die neuen Nutzeranmeldedaten ab, die als Standardanmeldedaten für Anwendungen verwendet werden sollen.
Die Nutzeranmeldedaten sind für die Autorisierung von
kubectl
erforderlich.gcloud auth application-default login
Ein neuer Browsertab wird geöffnet. Wählen Sie dort ein Konto aus.
Beispielcode herunterladen
Damit Sie schnell einsteigen können, ist Beispielcode in mehreren Sprachen verfügbar. So laden Sie den Beispielcode auf Ihren lokalen Rechner herunter:
So können Sie die Beispiel-API klonen oder herunterladen:
- 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.
- Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
cd java-docs-samples/endpoints/getting-started
So können Sie die Beispiel-API klonen oder herunterladen:
- 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.
- Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
cd python-docs-samples/endpoints/getting-started
So klonen Sie die Beispiel-API oder laden diese herunter:
- Prüfen Sie, ob die Umgebungsvariable
GOPATH
festgelegt ist. - Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
go get -u -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
- Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
So können Sie die Beispiel-API klonen oder herunterladen:
- 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.
- Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
cd php-docs-samples/endpoints/getting-started
So können Sie die Beispiel-API klonen oder herunterladen:
- 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.
- Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
cd ruby-docs-samples/endpoints/getting-started
So können Sie die Beispiel-API klonen oder herunterladen:
- 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.
- 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.
So konfigurieren Sie Endpoints:
- Öffnen Sie im Verzeichnis mit dem Beispielcode die Konfigurationsdatei
openapi.yaml
.Java Python Go PHP Ruby NodeJS Wichtige Hinweise:
- Im Konfigurationsbeispiel sind die Zeilen in der Nähe des Feldes
host
zu sehen, die Sie ändern müssen. Zum Bereitstellen der Dateiopenapi.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 Beispielgetting-started
ist im GitHub-Repository aller Sprachen die gleiche.
- Im Konfigurationsbeispiel sind die Zeilen in der Nähe des Feldes
- 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, lesen 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:
- Sie müssen sich im Verzeichnis
endpoints/getting-started
befinden. - 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.yaml
openapi.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 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.comgcloud 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 Feldname
Ihrer gRPC-Endpoints-Konfiguration angegeben haben.
Weitere Informationen zu den gcloud
-Befehlen finden Sie unter gcloud
-Dienste.
API-Back-End bereitstellen
Bisher haben Sie zwar das OpenAPI-Dokument für Service Management bereitgestellt, den Code für das API-Back-End haben Sie jedoch noch nicht implementiert. In diesem Abschnitt wird die Bereitstellung vorkonfigurierter Container für die Beispiel-API und den ESPv2 im Cluster beschrieben.
Erforderliche Berechtigungen prüfen
Folgen Sie dieser Berechtigungsempfehlung, um ein geeignetes Knotendienstkonto als Identität für die Kommunikation mit Google-Diensten auszuwählen. ESP und ESPv2 müssen mit Google ServiceController und Stackdriver kommunizieren. Für das Knotendienstkonto, das ESP und ESPv2 ausführt, sind zusätzliche IAM-Rollen erforderlich.
Wenn das Knotendienstkonto nicht das Compute Engine-Standarddienstkonto ist, fügen Sie die erforderlichen IAM-Rollen im nächsten Schritt hinzu:
Erforderliche IAM-Rollen hinzufügen:
Die folgenden IAM-Rollen sind für das Dienstkonto erforderlich, das für ESP und ESPv2 verwendet wird.
So fügen Sie dem Dienstkonto die IAM-Rollen „Dienstüberwacher“ und „Cloud Trace-Agent“ hinzu:
Console
- Wählen Sie in der Cloud Console das Projekt aus, in dem das Dienstkonto erstellt wurde.
- Öffnen Sie die Seite IAM/Iam . Auf der Seite sollten alle IAM-Mitglieder einschließlich aller Dienstkonten aufgelistet sein.
- Wählen Sie das Dienstkonto aus und klicken Sie rechts auf Bearbeiten.
- Das Fenster Berechtigungen bearbeiten wird geöffnet.
- Klicken Sie auf + Weitere Rolle hinzufügen.
- Klicken Sie auf Rolle auswählen und wählen Sie Dienstverwaltung > Dienstüberwacher aus.
- Klicken Sie auf + Weitere Rolle hinzufügen.
- Klicken Sie auf Rolle auswählen und wählen Sie Cloud Trace > Cloud Trace-Agent aus.
- Klicken Sie auf Speichern.
- Nun sollten Sie die Rollen Dienstüberwacher und Cloud Trace-Agent in der Spalte Rolle Ihres Dienstkontos auf der IAM-Seite sehen.
gcloud
Fügen Sie die Rolle "Dienstüberwacher" hinzu:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \ --role roles/servicemanagement.serviceController
Fügen Sie die Rolle "Cloud Trace Agent" hinzu, um Cloud Trace zu aktivieren:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \ --role roles/cloudtrace.agent
Weitere Informationen finden Sie unter Was sind Rollen und Berechtigungen?
Workload Identity:
Wenn Workload Identity verwendet wird, kann ein anderes Dienstkonto als das Knoten-Dienstkonto verwendet werden, um mit Google-Diensten zu kommunizieren. Sie können ein Kubernetes-Dienstkonto für den Pod erstellen, um ESP und ESPv2 auszuführen, ein Google-Dienstkonto erstellen und das Kubernetes-Dienstkonto dem Google-Dienstkonto zuordnen.
Folgen Sie dieser Anleitung, um ein Kubernetes-Dienstkonto mit einem Google-Dienstkonto zu verknüpfen.
Das Google-Dienstkonto sollte über die erforderlichen IAM-Rollen verfügen. Wenn nicht, führen Sie den Schritt Erforderliche IAM-Rollen hinzufügen aus, um sie hinzuzufügen.
Container in einem Cluster bereitstellen
Container bieten einen logischen Mechanismus für die Paketerstellung, bei dem Anwendungen von der Umgebung, in der sie ausgeführt werden, abstrahiert werden. Mit dem folgenden Verfahren stellen Sie die Beispiel-API und ESPv2 im Cluster bereit. So stellen Sie die Container für den Cluster bereit:
- Rufen Sie die Anmeldedaten für den Cluster ab und stellen Sie sie für
kubectl
bereit:gcloud container clusters get-credentials NAME --zone ZONE
Ersetzen Sie NAME durch den Clusternamen und ZONE durch die Clusterzone. - Stellen Sie einen Kubernetes-Dienst im GKE-Cluster bereit. Der Kubernetes-Dienst implementiert die API. Wenden Sie
git clone
auf dieses Repository an und gehen Sie mitcd getting-started/
zu dem Ordner, um die Kubernetes-KonfigurationsdateiLANG-deployment.yaml
zu bearbeiten, und ersetzen Sie in den ESPv2 Beta-Startoptionen SERVICE_NAME durch den Namen Ihres Dienstes.Java Python Go PHP Ruby NodeJS Beispiel:
args: [ "--listener_port=8081", "--backend=http://127.0.0.1:8080", "--service=echo-api.endpoints.example-project-12345.cloud.goog ", "--rollout_strategy=managed", ]
Mit der Option
--rollout_strategy=managed
legen Sie fest, dass der ESPv2 die zuletzt bereitgestellte Dienstkonfiguration verwendet. Wenn Sie diese Option angeben, erkennt der ESPv2 innerhalb einer Minute nach Bereitstellung einer neuen Dienstkonfiguration die Änderung und verwendet automatisch die neue Konfiguration. Wir empfehlen, diese Option festzulegen, anstatt eine bestimmte Konfigurations-ID anzugeben, die von ESPv2 verwendet werden soll. Informationen zu den anderen verwendeten ESPv2-Optionen finden Sie unter ESPv2-Startoptionen. - Starten Sie den Kubernetes-Dienst mit dem Befehl
kubectl apply
:Java kubectl apply -f java-deployment.yaml
Python kubectl apply -f python-deployment.yaml
Go kubectl apply -f golang-deployment.yaml
PHP kubectl apply -f php-deployment.yaml
Ruby kubectl apply -f ruby-deployment.yaml
NodeJS kubectl apply -f nodejs-deployment.yaml
Wenn Sie eine Fehlermeldung erhalten, lesen Sie die Informationen unter Fehlerbehebung bei Endpoints in GKE. Weitere Informationen finden Sie unter API-Back-End bereitstellen.
Externe IP-Adresse des Clusters abrufen
Zum Senden von Anfragen an die API ist die externe IP des Dienstes erforderlich. Nach dem Start Ihres Dienstes im Container kann es einige Minuten dauern, bis die externe IP-Adresse bereit ist.
- Rufen Sie die externe IP-Adresse auf: kubectl get service
- Notieren Sie sich den Wert für
EXTERNAL-IP
. Sie benötigen diese IP-Adresse, wenn Sie eine Anfrage an die Beispiel-API senden.
Anfrage über eine IP-Adresse senden
Der Dienst wird jetzt im Containercluster ausgeführt und Sie haben die externe IP-Adresse, also 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.
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.
- Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus.
- Kopieren Sie den Schlüssel in die Zwischenablage.
- Klicken Sie auf Schließen.
- 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..."
- In Linux oder macOS:
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 Wertapplication/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!
API-Aktivität verfolgen
So verfolgen Sie API-Aktivitäten:
- Sehen Sie sich auf der Seite Endpoints > Dienste die Aktivitätsgrafiken für Ihre API an.
Es kann einen Moment dauern, bis die Anfrage in den Grafiken angezeigt wird. - Sehen Sie sich auf der Seite "Loganzeige" die Anfragelogs an.
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:
- Öffnen Sie die OpenAPI-Konfigurationsdatei
openapi.yaml
und fügen Sie das Attributx-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"
- Ersetzen Sie im Attribut
name
den Parameter YOUR_PROJECT_ID durch Ihre Projekt-ID. - 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. - 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
Entwicklerportal für die API erstellen
Sie können mit dem Cloud Endpoints-Portal ein Entwicklerportal erstellen. Dabei handelt es sich um 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.
Informationen zum Beenden der in dieser Anleitung verwendeten Dienste finden Sie unter API und API-Instanzen löschen.