Deployments verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

Vorschau — Apigee API hub

Diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Funktionen sind „wie besehen“ verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Eine API kann mehrere Deployments haben, beispielsweise für unterschiedliche Staging-Umgebungen oder Regionen. Ein Deployment ist ein Ort (eine Adresse), an dem Nutzer auf eine API zugreifen können. Eines dieser Deployments kann als empfohlenes Deployment angegeben werden.

Im Tab Deployments werden alle Deployments für die API angezeigt, die von einem Nutzer mit Bearbeitungsberechtigungen konfiguriert wurden. Deployments sind alphabetisch nach Umgebung aufgelistet.

API Registry-Schema ansehen

Im Folgenden werden die Beziehungen zwischen API-Hub-APIs, Versionen, Deployments und Spezifikationen veranschaulicht.

Referenz	Posten	Beschreibung
	registry	Eine Registry ist eine Sammlung von APIs, die als API-Katalog dient.
	Version	Eine API kann mehrere Versionen haben. Eine Version sollte einer stabilen Schnittstelle entsprechen, mit der Clients eine API aufrufen können. Eine dieser Versionen kann als die empfohlene Version bezeichnet werden. In der semver-Terminologie empfiehlt es sich, Versionen als Hauptversionen zu erstellen.
	Deployment	Eine API kann mehrere Deployments haben, z. B. unterschiedliche Staging-Umgebungen oder Regionen. Ein Deployment ist ein Ort (eine Adresse), an dem Nutzer auf eine API zugreifen können. Eines dieser Deployments kann das empfohlene Deployment sein.
	Spezifikation	Es wird empfohlen, eine API-Version durch formale Spezifikationen zu beschreiben. Dabei werden oft verschiedene API-Spezifikationsformate verwendet. Eines dieser Spezifikationsformate kann primär sein, was bedeutet, dass andere Spezifikationen für diese Version von diesem Format abgeleitet werden.
	Revisionen	Deployments haben einen Überarbeitungsverlauf. Deployment-Revisionen stellen bestimmte Instanzen einer Bereitstellung zeitlich dar und können auf eine oder mehrere Spezifikationsüberarbeitungen verweisen, wenn sich die von der Bereitstellung bereitgestellte API-Implementierung geändert hat. Spezifikationen haben einen Überarbeitungsverlauf. Spezifikationsüberarbeitungen stellen nachfolgende Instanzen einer Spezifikation dar und stellen in der Regel abwärtskompatible Änderungen an Spezifikationsinhalten dar. In der semver-Terminologie können Überarbeitungen Neben- oder Punktversionen entsprechen.

Deployment hinzufügen

So fügen Sie ein Deployment hinzu:

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

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie in der Liste der APIs auf eine API-Zeile. Standardmäßig wird der Tab Übersicht angezeigt.
3. Wählen Sie den Tab Deployments aus.
4. Klicken Sie auf Deployment hinzufügen.
5. Machen Sie die folgenden Angaben:
   • ID: Eine Kennung für eine API-Ressource. Die ID darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten. Die ID muss im Projekt eindeutig sein. IDs müssen zwischen 4 und 63 Zeichen lang sein. IDs können nach dem Erstellen eines Deployments nicht mehr geändert werden.
   • Umgebung: Der Standort, an dem die Instanz einer API verfügbar ist, beispielsweise für "Produktion", "Staging", "Test" usw.
   • Gateway: Der Gateway-Typ. Der Proxy, der zum Bereitstellen und zum Schutz der API verwendet wird. Wird als Systemtaxonomie definiert.

   • API-Version: Die Version der API, die von diesem Deployment bereitgestellt wird. Wenn eine Version keine Überarbeitungen hat, wird sie in der Liste entsprechend markiert und kann nicht ausgewählt werden.

     
   • Name und URL des externen Kanals: Ein Label und eine URL für einen Link zu einem externen Kanal für die API, z. B. zu einem Entwicklerportal.
   • Zugriff auf Informationen
     • Nutzungsanleitung: Anleitung zur Angabe der Zielgruppe für das Deployment. Beispiele: öffentliche Nutzung, interne Tests usw.
     • Serverendpunkt: der Serverendpunkt für die API
     • Zugriffsanleitung: Markdown-Inhalt im freien Format, der erläutert, wie API-Nutzer Zugriff auf das Deployment erhalten.
6. Klicken Sie auf Speichern (oder Abbrechen).

Deployment bearbeiten

So bearbeiten Sie ein Deployment:

1. Gehen Sie in der Cloud Console zur Seite API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie in der Liste der APIs auf eine API-Zeile. Standardmäßig wird der Tab Übersicht angezeigt.
3. Wählen Sie den Tab Deployments aus.
4. Klicken Sie neben dem gewünschten Deployment auf Mehr > Bearbeiten.
5. Nehmen Sie nach Bedarf Änderungen vor.

6. Überarbeitung aktualisieren: Dieses Kästchen wird angezeigt, wenn die aktuell ausgewählte Version eine Spezifikationsüberarbeitung enthält, die aktueller ist als die dem Deployment bisher zugewiesene Überarbeitung. Klicken Sie auf das Kästchen, damit die bereitgestellte Überarbeitung der Spezifikation aktualisiert wird.

   
7. Klicken Sie auf Speichern (oder Abbrechen).

Deployment löschen

So löschen Sie ein Deployment:

1. Gehen Sie in der Cloud Console zur Seite API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie in der Liste der APIs auf eine API-Zeile. Standardmäßig wird der Tab Übersicht angezeigt.
3. Wählen Sie den Tab Deployments aus.
4. Klicken Sie neben dem gewünschten Deployment auf Mehr > Löschen.
5. Klicken Sie bei Aufforderung auf Löschen (oder Abbrechen).

Empfohlenes Deployment angeben

So legen Sie ein empfohlenes Deployment fest oder löschen es:

1. Gehen Sie in der Cloud Console zur Seite API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie in der Liste der APIs auf eine API-Zeile. Standardmäßig wird der Tab Übersicht angezeigt.
3. Wählen Sie den Tab Deployments aus.
4. Klicken Sie in der gewünschten Bereitstellungszeile auf Mehr > Als empfohlen festlegen. Sie können ein empfohlenes Deployment nicht löschen; Sie können nur ein anderes Deployment als empfohlen angeben.

Zugang erhalten

Hinweis: Zugriffsinformationen werden mit dem Deployment angegeben. Weitere Informationen finden Sie unter Deployment hinzufügen.

So rufen Sie Informationen zum Zugriff auf eine API auf:

1. Gehen Sie in der Cloud Console zur Seite API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie in der Liste der APIs auf eine API-Zeile. Standardmäßig wird der Tab Übersicht angezeigt.
3. Klicken Sie im Bereich Allgemein oder Deployments auf Zugang erhalten, um das API-Feld Zugang zu öffnen. Wird die Schaltfläche Zugriff erhalten nicht angezeigt, wurden keine Informationen bereitgestellt. Unter Deployment hinzufügen finden Sie eine Anleitung zum Hinzufügen von Zugriffsinformationen.

4. Wählen Sie ein Deployment aus der Liste aus. Wenn ein Deployment keine Zugriffsinformationen hat, wird es in der Liste als solche markiert und kann nicht ausgewählt werden.

   

Zum externen Kanal wechseln

Hinweis: Beim Erstellen eines Deployments wird immer ein externer Kanal definiert. Weitere Informationen finden Sie unter Deployment hinzufügen.

So rufen Sie einen externen Kanal auf:

1. Gehen Sie in der Cloud Console zur Seite API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie in der Liste der APIs auf eine API-Zeile. Standardmäßig wird der Tab Übersicht angezeigt.
3. Wählen Sie den Tab Deployments aus.

4. Klicken Sie auf einen Link zum externen Kanal, um zu einem externen Kanal wie z. B. ein Portal zu wechseln, falls ein solcher definiert wurde.