Deployments verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

In diesem Dokument wird beschrieben, wie API-Bereitstellungen erstellt und verwaltet werden. Weitere Informationen finden Sie unter Einführung in API-Bereitstellungen.

Deployment erstellen

Sie können eine Bereitstellung in der Console oder mit der REST API erstellen.

Console

So erstellen Sie ein neues Deployment:

Rufen Sie in der Google Cloud Console die Seite API-Hub auf.
Zum API-Hub
Klicken Sie auf APIs.
Verwenden Sie bei Bedarf Search, um eine API zu finden.
Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
Versionen auswählen
Klicken Sie auf Deployment hinzufügen.
Geben Sie die Bereitstellungsdetails im Formular Neue Bereitstellung hinzufügen an. Sie müssen einen Anzeigenamen angeben. Die anderen sind optional.

REST

So fügen Sie ein neues Deployment mit der Create a deployment API hinzu:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPLOYMENT_ID: (Optional) Die ID der Bereitstellung. Wenn nicht angegeben, wird eine vom System generierte ID verwendet. Der Name muss ein String mit 4 bis 63 Zeichen sein, wobei gültige Zeichen /[a-z][0-9]-/. sind.
DISPLAY_NAME: (Erforderlich) Der Anzeigename des Deployments. Sie können einen beliebigen Namen verwenden.

Zusätzlich zum erforderlichen Anzeigenamen können Sie an eine Bereitstellung optionale Attribute und Entitäten anhängen. Diese zusätzlichen Elemente werden in der Beschreibung der Bereitstellungsressource in der REST API-Referenz beschrieben.

Beispielausgabe:

{

}

Bereitstellung zu einer API-Version hinzufügen

API-Bereitstellungen müssen mit API-Versionen verknüpft sein.

Schritte noch nicht festgelegt.

Bereitstellungsdetails abrufen

In diesem Abschnitt wird erläutert, wie Sie Details zu einer API-Bereitstellung abrufen.

Console

So zeigen Sie Details einer Bereitstellung über die Benutzeroberfläche an:

Rufen Sie in der Google Cloud Console die Seite API-Hub auf.
Zum API-Hub
Klicken Sie auf APIs.
Verwenden Sie bei Bedarf Search, um eine API zu finden.
Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
Wählen Sie die Bereitstellung aus.

REST

Mit der Get deployment details API können Sie Details zu einer Bereitstellung aufrufen:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPLOYMENT_ID: Die ID der Bereitstellung.

Beispielausgabe:

{
    xxx
  }

Deployments auflisten

In diesem Abschnitt wird erläutert, wie Sie die Bereitstellungen auflisten.

Console

So listen Sie Bereitstellungen mit der Benutzeroberfläche auf:

Rufen Sie in der Google Cloud Console die Seite API-Hub auf.
Zum API-Hub
Klicken Sie auf APIs.
Verwenden Sie bei Bedarf Search, um eine API zu finden.
Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
Wählen Sie die Bereitstellung aus.

REST

Verwenden Sie die List Deployments API, um alle Bereitstellungen aufzulisten:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.

Beispielausgabe:

{

      }

API-Bereitstellung löschen

In diesem Abschnitt wird erläutert, wie Sie die API-Bereitstellung löschen.

Console

Verwenden Sie zum Löschen einer API-Bereitstellung die Delete deployment API:

So löschen Sie API-Ressourcen über die UI:

Rufen Sie in der Google Cloud Console die Seite API-Hub auf.
Zum API-Hub
Klicken Sie auf APIs.
Verwenden Sie bei Bedarf Search, um eine API zu finden.
Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
Wählen Sie die Bereitstellung aus.
Wählen Sie im Aktionsmenü die Option Löschen aus.

REST

Verwenden Sie die API Delete API resource, um eine API-Ressource aus dem API-Hub zu löschen:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPLOYMENT_ID: Die ID der Bereitstellung.

Beispielausgabe:

{

      }

Deployment bearbeiten

Console

Rufen Sie in der Google Cloud Console die Seite API-Hub auf.
Zum API-Hub
Klicken Sie auf APIs.
Verwenden Sie bei Bedarf Search, um eine API zu finden.
Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
Wählen Sie die Version aus.

REST

Verwenden Sie zum Bearbeiten eines Deployments die Patch Deployment API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        TBD
      {'

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPLOYMENT_ID: ID des zu bearbeitenden Deployments.

Sie können zusätzliche optionale Attribute für die API hinzufügen und diese in den Anfragetext einfügen oder sie später hinzufügen. Sie können beispielsweise eine Beschreibung, einen Inhaber und einen Link zur API-Dokumentation angeben. Weitere Informationen finden Sie unter API Hub API.