API auf einem Gateway bereitstellen

Vorbereitung

Bevor Sie eine API-Konfiguration in API Gateway bereitstellen können, müssen folgende Voraussetzungen erfüllt sein:

Anforderungen an Gateway-ID

Für viele der unten aufgeführten gcloud-Befehle müssen Sie die ID des Gateways im Format GATEWAY_ID angeben. In API Gateway gelten für die Gateway-ID die folgenden Anforderungen:

  • Darf maximal 49 Zeichen lang sein.
  • Darf nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten.
  • Er darf nicht mit einem Bindestrich beginnen.
  • Er darf keinen Unterstrich enthalten.

Endpunkt der bereitgestellten API-Konfiguration definieren

Wenn Sie eine API-Konfiguration für ein Gateway bereitstellen, erstellt API Gateway eine eindeutige URL für das Gateway in der Domain gateway.dev. Ihre API-Clients verwenden dann eine URL im folgenden Format, um auf die bereitgestellte API-Konfiguration zuzugreifen:

https://GATEWAY_ID-HASH.REGION_CODE.gateway.dev

Dabei ist GATEWAY_ID der Name des Gateways, HASH der eindeutige Hashcode, der beim Bereitstellen der API generiert wurde, und REGION_CODE der Code für die GCP-Region ist, in der Sie das Gateway bereitgestellt haben.

Beispiel:

https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

API-Konfiguration für ein Gateway bereitstellen

Verwenden Sie die Google Cloud CLI, um eine API-Konfiguration in einem Gateway bereitzustellen. Wenn Sie die API-Konfiguration bereitstellen, müssen Sie den Namen der API angeben. Wenn das Gateway noch nicht für die API vorhanden ist, wird es mit diesem Befehl ebenfalls erstellt.

So stellen Sie eine API-Konfiguration für ein Gateway bereit:

  1. Überprüfen Sie anhand der Projekt-ID, die vom folgenden Befehl zurückgegeben wurde, ob das Gateway im richtigen Projekt erstellt wird.

    gcloud config list project

    Wenn Sie das Standardprojekt ändern müssen, führen Sie den folgenden Befehl aus und ersetzen Sie PROJECT_ID durch die ID des Google Cloud-Projekts, in dem Sie den Dienst erstellen möchten:

    gcloud config set project PROJECT_ID

  2. Hier erhalten Sie Hilfe zum Befehl gateway create:

    gcloud api-gateway gateways create --help

  3. Führen Sie den folgenden Befehl aus, um die API-Konfiguration für das Gateway bereitzustellen:

    gcloud api-gateway gateways create GATEWAY_ID \
  --api=API_ID --api-config=CONFIG_ID \
  --location=GCP_REGION --project=PROJECT_ID

    Dabei gilt:

    • GATEWAY_ID gibt die ID des neuen Gateways an. Wenn das Gateway noch nicht vorhanden ist, wird es mit diesem Befehl erstellt.
    • API_ID gibt die ID der API Gateway API an, die mit diesem Gateway verknüpft ist.
    • CONFIG_ID gibt die ID der API-Konfiguration an, die für das Gateway bereitgestellt wird. Sie müssen beim Erstellen eines Gateways eine API-Konfiguration angeben.

    • GCP_REGION gibt die GCP-Region für das bereitgestellte Gateway an.

    • PROJECT_ID die Google Cloud-Projekt-ID angibt.

    Beim Erstellen des Gateways gibt gcloud Informationen an das Terminal aus.

  4. Nach erfolgreichem Abschluss können Sie den folgenden Befehl verwenden, um Details zum Gateway anzuzeigen:

    gcloud api-gateway gateways describe GATEWAY_ID \
  --location=GCP_REGION --project=PROJECT_ID

    Dieser Befehl gibt Folgendes zurück:

    apiConfig: projects/PROJECT_ID/locations/global/apis/API_ID/configs/CONFIG_ID
createTime: '2020-02-05T13:44:12.997862831Z'
defaultHostname: my-gateway-a12bcd345e67f89g0h.uc.gateway.dev
displayName: GATEWAY_ID
name: projects/PROJECT_ID/locations/GCP_REGION/gateways/GATEWAY_ID
serviceAccount:
  email: gateway-111111@222222-tp.iam.gserviceaccount.com
state: ACTIVE
updateTime: '2020-02-05T13:45:00.844705087Z'

    Beachten Sie den Wert des Attributs defaultHostname. Dies ist der Hostname-Teil der Gateway-URL. Für den Zugriff auf eine für dieses Gateway bereitgestellte API-Konfiguration verwenden Sie eine URL im folgenden Format:

    https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

Die Google Cloud CLI bietet viele Optionen, einschließlich der in der gcloud-Referenz beschriebenen Optionen. Darüber hinaus können Sie für API Gateway beim Erstellen eines Gateways die folgenden Optionen festlegen:

  • --async: Gibt die Steuerung sofort an das Terminal zurück, ohne auf den Abschluss des Vorgangs zu warten.
  • --display-name=NAME: Gibt den Anzeigenamen des Gateways an, d. h. den auf der Benutzeroberfläche angezeigten Namen. Verwenden Sie keine Leerzeichen im Namen. Verwenden Sie stattdessen Bindestriche und Unterstriche. Der Standardwert ist GATEWAY_ID.
  • --labels=KEY1=VALUE1,KEY2=VALUE2,...: Gibt Labels an, die dem Gateway zugeordnet sind.

Gateways auflisten

So listen Sie Gateways für ein bestimmtes Projekt auf:

gcloud api-gateway gateways list --project=PROJECT_ID

Dieser Befehl gibt eine Ausgabe in der folgenden Form zurück:

GATEWAY_ID        LOCATION       DISPLAY_NAME     STATE     CREATE_TIME          UPDATE_TIME
my-gateway        us-central1    my-gateway       ACTIVE    2021-01-07T00:04:19  2022-05-21T00:33:46

So listen Sie Gateways für ein bestimmtes Projekt und eine bestimmte Region auf:

gcloud api-gateway gateways list --location=GCP_REGION --project=PROJECT_ID

Verwenden Sie einen filter-Ausdruck, um die mit einer bestimmten API verknüpften Gateways aufzulisten:

gcloud api-gateway gateways list \
  --filter="apiConfig:projects/PROJECT_ID/locations/global/apis/API_ID/*" \
  --project=PROJECT_ID

Oder verwenden Sie diese filter, um Gateways für eine bestimmte API-Konfiguration aufzulisten:

gcloud api-gateway gateways list \
  --filter="apiConfig:projects/PROJECT_ID/locations/global/apis/API_ID/configs/CONFIG_ID" \
  --project=PROJECT_ID

Rufen Sie mithilfe der Projekt-, Regions- und Gateway-IDs detaillierte Informationen zum Gateway ab, einschließlich der Identität der API-Konfiguration, die auf dem Gateway bereitgestellt wird:

gcloud api-gateway gateways describe GATEWAY_ID \
  --location=GCP_REGION --project=PROJECT_ID

Gateway aktualisieren

Aktualisieren Sie ein Gateway zu:

  • Andere API-Konfiguration für das Gateway bereitstellen
  • Anzeigenamen aktualisieren
  • Aktualisieren Sie die Labels

Verwenden Sie den folgenden gcloud-Befehl, um ein vorhandenes Gateway zu aktualisieren, wobei UPDATE_OPTIONS durch das Flag der Gateway-Option und den Wert ersetzt wird, den Sie aktualisieren möchten: 

gcloud api-gateway gateways update GATEWAY_ID \
  UPDATE_OPTIONS --api=API_ID --location=GCP_REGION --project=PROJECT_ID

So aktualisieren Sie beispielsweise die für das Gateway bereitgestellte API-Konfiguration:

gcloud api-gateway gateways update GATEWAY_ID \
  --api-config=NEW_CONFIG_ID --api=API_ID --location=GCP_REGION --project=PROJECT_ID

Dabei gibt NEW_CONFIG_ID die neue API-Konfiguration an, die im Gateway bereitgestellt werden soll.

Eine vollständige Liste der verfügbaren Update-Flags und -Argumente finden Sie in der Referenz zu gcloud api-gatewaygateways update. Sie können auch den folgenden Befehl verwenden, um alle Aktualisierungsoptionen anzusehen:

gcloud api-gateway gateways update --help

Gateway löschen

Verwenden Sie den folgenden gcloud-Befehl, um ein vorhandenes Gateway zu löschen:

gcloud api-gateway gateways delete GATEWAY_ID \
  --location=GCP_REGION --project=PROJECT_ID

Nächste Schritte