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. Nachdem Sie eine Bereitstellungsentität erstellt haben, können Sie sie mit einer oder mehreren API-Versionen verknüpfen.

Deployment erstellen

Sie können eine Bereitstellungsentität in der Console oder mit der REST API erstellen.

Console

So erstellen Sie ein neues Deployment:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Klicken Sie auf dem Tab Deployments auf Deployment hinzufügen.
  6. Geben Sie im Formular Bereitstellung erstellen die Bereitstellungsdetails an:
    • Bereitstellungs-ID: Klicken Sie auf Eindeutige ID angeben, um optional eine eindeutige ID für die Bereitstellung anzugeben. Wenn Sie die ID weglassen, wird sie vom API-Hub für Sie erstellt. Die ID muss 4 bis 500 Zeichen lang sein und gültige Zeichen sind /[A-Z][a-z][0-9]-/..
    • Bereitstellungsname: (Erforderlich) Geben Sie einen Anzeigenamen für die Bereitstellung an.
    • Beschreibung: Geben Sie eine Beschreibung der Bereitstellung ein.
    • Bereitstellungstyp: Wählen Sie den Bereitstellungstyp aus. Die möglichen Werte sind in einem Systemattribut definiert und können unter Attribute verwalten geändert werden.
    • Ressourcen-URI: (Erforderlich) Geben Sie einen URI zur Laufzeitressource an. Mit diesem URI kann die Ressource verwaltet werden. Wenn die Laufzeitressource beispielsweise ein Apigee API-Proxy ist, muss dieses Feld den URI zur Verwaltungs-UI des Proxys enthalten.
    • Umgebung: Die Umgebung, die dieser Bereitstellung zugeordnet wird. Die Umgebung wird dem systemdefinierten Umgebungsattribut zugeordnet.
    • Dokumentation: Geben Sie einen Link zur Dokumentation für die Bereitstellung ein.
    • SLO: Geben Sie das SLO für diese Bereitstellung an. Dies entspricht dem systemdefinierten SLO-Attribut. Sie können die Werte für dieses Attribut unter Attribute verwalten ändern.
    • Endpunkte: (Erforderlich) Geben Sie die Endpunkte an, an denen diese Bereitstellungsressource auf API-Anfragen wartet. Das kann eine Liste von vollständigen URIs, Hostnamen oder IP-Adressen sein.
    • Mit einer Version verknüpfen: Verknüpfen Sie die Bereitstellung mit einer oder mehreren API-Versionen.
    • Benutzerdefinierte Attribute: Benutzerdefinierte Schlüssel/Wert-Paare. Sie können benutzerdefinierte Attribute unter Attribute verwalten hinzufügen.
  7. Klicken Sie auf Erstellen.

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 500 Zeichen sein, wobei gültige Zeichen /[a-z][A-Z][0-9]-_/. sind.
  • DISPLAY_NAME: (Erforderlich) Der Anzeigename des Deployments. Sie können einen beliebigen Namen verwenden.
  • Optionale Attribute: Zusätzlich zum erforderlichen Anzeigenamen können Sie einer Bereitstellung optionale Attribute und Entitäten anhängen. Diese zusätzlichen Elemente werden in der Beschreibung der Bereitstellungsressource in der REST API-Referenz beschrieben.

Bereitstellung zu einer API-Version hinzufügen

Mit einer Version können eine oder mehrere Bereitstellungen verknüpft sein. In diesem Abschnitt wird erläutert, wie Sie Bereitstellungen mit Versionen verknüpfen. Sie können Bereitstellungen beim Erstellen einer Version verknüpfen oder sie bearbeiten, um sie mit einer vorhandenen Version zu verknüpfen. Weitere Informationen finden Sie unter API-Version erstellen und Version bearbeiten.

Damit eine Bereitstellung mit einer neuen oder vorhandenen Version verknüpft werden kann, muss die Bereitstellung bereits vorhanden sein. Weitere Informationen finden Sie unter Bereitstellung erstellen.

Console

So fügen Sie einer Version eine Bereitstellung hinzu:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. API auswählen.
  5. Suchen Sie in der Tabelle Versionen die Version, die Sie bearbeiten möchten.
  6. Wählen Sie rechts neben der Versionszeile im Menü „Aktionen“ die Option Bearbeiten aus oder wählen Sie die Version aus und klicken Sie auf der Detailseite auf Version bearbeiten.
  7. Wählen Sie unter Mit einer Bereitstellung verknüpfen eine oder mehrere Bereitstellungen aus, die mit der Version verknüpft werden sollen, und klicken Sie auf OK.
  8. Klicken Sie auf Speichern.

REST

Beispiel für das Hinzufügen einer Bereitstellung zu einer Version:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

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.
  • API_NAME: Der Name der API mit der Version, die Sie bearbeiten möchten.
  • VERSION_ID: Die ID der zu bearbeitenden Version.
  • DEPLOYMENTS: Der vollständig qualifizierte Ressourcenname einer oder mehrerer Bereitstellungen. Beispiel: "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

Deployments auflisten

In diesem Abschnitt wird erläutert, wie Sie die Bereitstellungen auflisten. Sie können alle Bereitstellungen auflisten, die mit allen Versionen einer API verknüpft sind, oder alle Bereitstellungen, die mit einer bestimmten Version verknüpft sind.

Console

So listen Sie Bereitstellungen mit der Benutzeroberfläche auf:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Wählen Sie den Tab Deployments aus, um alle mit der API verknüpften Deployments aufzulisten.
  6. Wählen Sie auf dem Tab Versionen eine Version aus, um die mit dieser Version verknüpften Bereitstellungen aufzurufen.

REST

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

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/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.

Bereitstellungsdetails abrufen

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

Console

So rufen Sie Details zu einer Bereitstellung auf:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Wählen Sie den Tab Deployments aus, um alle mit der API verknüpften Deployments aufzulisten.
  6. Wählen Sie die Bereitstellung aus, um die zugehörige Seite mit Details aufzurufen.

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 eindeutige ID der Bereitstellung.

API-Bereitstellung aus einer API löschen

In diesem Abschnitt wird erläutert, wie Sie die API-Bereitstellung löschen. Wenn Sie eine API-Bereitstellung aus einer API löschen, wird zuerst die Verknüpfung mit allen Versionen der API aufgehoben und dann die Bereitstellung aus der API gelöscht. Nach dem Löschen einer Bereitstellung wird sie nicht mehr in der Liste der Bereitstellungen angezeigt und Sie können APIs nicht mehr anhand der gelöschten Bereitstellung filtern.

Console

So löschen Sie eine Bereitstellung über die Benutzeroberfläche:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Wählen Sie den Tab Deployments aus, um alle mit der API verknüpften Deployments aufzulisten.
  6. Suchen Sie die Bereitstellung, die Sie löschen möchten.
  7. Wählen Sie im Menü Aktion der Bereitstellung die Option Löschen aus.

REST

Verwenden Sie die Delete deployment API, um eine Bereitstellung 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 eindeutige ID des zu löschenden Deployment.

Verknüpfung einer API-Bereitstellung mit einer API oder Version aufheben

In diesem Abschnitt wird erläutert, wie Sie die Verknüpfung einer API-Bereitstellung mit einer API oder Version aufheben. Wenn Sie die Verknüpfung einer Bereitstellung mit einer API aufheben, wird die Verknüpfung mit allen Versionen der API aufgehoben. Wenn die Verknüpfung aufgehoben wird, wird die Bereitstellung nicht mehr in der Liste der Bereitstellungen angezeigt.

Console

So heben Sie über die Benutzeroberfläche die Verknüpfung einer Bereitstellung mit einer API auf:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Wählen Sie den Tab Deployments aus, um alle mit der API verknüpften Deployments aufzulisten.
  6. Suchen Sie die Bereitstellung, deren Verknüpfung Sie aufheben möchten.
  7. Wählen Sie im Menü Aktion der Bereitstellung die Option Verknüpfung mit API aufheben aus.

So heben Sie über die Benutzeroberfläche die Verknüpfung einer Bereitstellung mit einer Version auf:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Version auswählen
  6. Suchen Sie im Abschnitt Bereitstellungen nach der Bereitstellung, deren Verknüpfung Sie aufheben möchten.
  7. Wählen Sie im Menü Aktion der Bereitstellung die Option Verknüpfung mit Version aufheben aus.

REST

Verwenden Sie die API Delete deployment, 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 eindeutige ID des zu löschenden Deployment.

Deployment bearbeiten

In diesem Abschnitt wird erläutert, wie Sie eine Bereitstellung bearbeiten.

Console

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörigen Details aufzurufen.
  5. Wählen Sie den Tab Deployments aus, um alle mit der API verknüpften Deployments aufzulisten.
  6. Suchen Sie die Bereitstellung, die Sie bearbeiten möchten.
  7. Wählen Sie im Menü Aktion der Bereitstellung die Option Bearbeiten aus oder klicken Sie auf die Bereitstellung und dann im Bereich „Bereitstellungsdetails“ auf Bereitstellung bearbeiten.

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"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

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.
  • DEPLOYMENT_ATTRIBUTES: Hängen Sie die Attribute, die Sie ändern möchten, im Anfragetext an. Die bearbeitbaren Attribute werden in der Beschreibung der Bereitstellungsressource in der REST API-Referenz beschrieben.