Informationen zu Organisationen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Eine Organisation ist der übergeordnete Container in Apigee. Sie enthält alle Ihre API-Proxys und die zugehörigen Ressourcen. Im weiteren Verlauf dieses Themas werden Organisationen ausführlicher behandelt. Hier ein paar nützliche Hinweise:

  • Nachdem eine Organisation erstellt wurde, können Sie sie nicht mehr umbenennen.
  • Der Name Ihrer Organisation befindet sich in der URL der Apigee-Benutzeroberfläche. Beispiele:
    https://apigee.google.com/organizations/ORG_ID
  • Wenn Sie Aufrufe mit der Apigee API ausführen, ist die Organisation bei den meisten Aufrufen ein erforderlicher Teil des Pfads. Die folgende curl-Anfrage gibt beispielsweise eine Liste aller API-Proxys in einer Organisation mithilfe der Organizations API zurück:
    curl https://apigee.googleapis.com/v1/organizations/YOUR_ORG_ID/apis
  • Sie haben zwar nur eine Organisation erstellt, können aber zu anderen Organisationen als Nutzer oder Administrator mit bestimmten Berechtigungen gehören. Sie können zu einer anderen Organisation wechseln, wie unter Zwischen Organisationen wechseln beschrieben.
  • Eine Apigee-Organisation ist nicht dasselbe wie eine Google Cloud-Organisation. Wenn die Möglichkeit der Mehrdeutigkeit besteht, wird in diesem Dokument darauf hingewiesen, dass es sich um eine Apigee-Organisation handelt.

Video: In einem kurzen Video erfahren Sie, wie Organisationen eine mandantenfähige Architektur für die API-Verwaltung unterstützen.

Organisationstypen

Es gibt zwei Arten von Organisationen:

  • Kostenpflichtig:Eine permanente Organisation mit voller Skalierbarkeit. Diese Organisationen werden auch als Produktionsorganisationen bezeichnet. Kostenpflichtige Organisationen sind Organisationen, die im Rahmen eines Abos oder eines „Pay as you go“-Preismodells von Apigee erstellt werden.

  • Evaluierung: Eine temporäre Self-Service-Organisation, mit der Sie Apigee testen können. Diese Organisationen werden auch als eval orgs bezeichnet. Sie sind zeitlich begrenzt und haben nicht die Skalierbarkeit und Flexibilität von Produktionsorganisationen.

Siehe auch Vergleich von Evaluierungs- und bezahlten Organisationen.

Lebensdauer einer Evaluierungsorganisation

Evaluierungsorganisationen haben eine begrenzte Lebensdauer.

  1. Tag 0: Sie erstellen die Evaluierungsorganisation.
  2. Tag 30: Google sendet Ihnen eine E-Mail-Benachrichtigung mit einer Warnung zum bevorstehenden Ablauf der Evaluierung.
  3. Tag 60: Google löscht die Evaluierungsorganisation.

Organisationskomponenten

Die folgende Abbildung zeigt die wichtigsten Komponenten des Apigee-Organisationsmodells. Dieses Modell definiert, wie Ihre APIs, API-Produkte, Anwendungen und Anwendungsentwickler innerhalb von Apigee miteinander verknüpft sind.

Hierarchisches Diagramm, das die Organisation als Root-Element einer Apigee-Bereitstellung darstellt.

Dieses Modell zeigt nicht alle Features von Apigee, sondern soll veranschaulichen, dass die Organisation das Root-Element einer Bereitstellung ist.

In der folgenden Tabelle werden die Komponenten des Organisationsmodells näher beschrieben:

Komponente Beschreibung
Organisation

Jede Apigee-Organisation gehört genau zu einem Google Cloud-Projekt und ein Projekt kann höchstens eine Organisation enthalten. Eine Organisation enthält Umgebungen, API-Proxys, API-Produkte, API-Pakete, Anwendungen und Nutzer.

Kontoinhaber sind nicht auf eine einzelne Organisation beschränkt. Einige Kontoinhaber definieren oder definieren mehrere Organisationen, die unterschiedliche Communitys für App-Entwickler unterstützen.

Umgebungen und Umgebungsgruppen

Eine Umgebung ist eine isolierte Softwareumgebung innerhalb einer Organisation, in der Sie API-Proxys bereitstellen. Sie können in einer Organisation mehrere Umgebungen erstellen.

Eine Umgebungsgruppe ist eine Gruppe von Umgebungen mit einem oder mehreren Hostnamen. Der Hostname ist Teil der URL, die zum Aufrufen von API-Proxys verwendet wird, die in einer beliebigen Umgebung in der Umgebungsgruppe bereitgestellt werden.

API-Proxy

Ein API-Proxy ist eine Schnittstelle zwischen eingehenden Anfragen und Backend-Diensten. Die Proxy-Entität enthält die Anweisungen und Richtlinien, die Apigee bei der Verarbeitung von Anfragen von Clients und Antworten vom Back-End ausführt.

API-Produkt

Entität zur Veröffentlichung von APIs. API-Produkte werden im Entwicklerportal veröffentlicht, damit sie von externen Entwicklern genutzt werden können. Ein API-Produkt stellt eine Schnittstelle für den Zugriff auf eine oder mehrere veröffentlichte APIs dar. Die Schnittstelle (kann mit einer OpenAPI-Spezifikation beschrieben werden) kann eine Kombination aus einem oder mehreren der API-Anfragen enthalten, die von einem oder mehreren API-Proxys verarbeitet werden.

Die Nutzer in einer Organisation erstellen API-Produkte. In diesem Fall können sie jedem API-Produkt beliebige Metadaten hinzufügen. Ein häufig verwendeter Metadatentyp kann einen Serviceplan definieren, der Zugriffsbeschränkungen für API-Aufrufe festlegt, Sicherheitsanforderungen festlegt, Monitoring und Analysen ermöglicht und zusätzliche Features bereitstellt.

Apigee erfasst Daten für die Analyse von API-Produkten.

API-Anbieter

Die Person oder Entität, die API-Proxys und -Produkte erstellt und verwaltet. Entwickler von Client-Anwendungen greifen auf diese veröffentlichten APIs zu.

App-Entwickler

Eine Organisation hat einen oder mehrere Entwickler, die die Anwendungen erstellen, die die in Ihrer Organisation definierten APIs (als API-Produkte veröffentlicht) nutzen. Entwickler nutzen APIs, können jedoch keine APIs erstellen oder andere Aktionen in der Organisation ausführen.

Entwickler können zu Ihrem Unternehmen gehören, Partner oder externe Entwickler sein, die für den Zugriff auf Ihre APIs bezahlen oder nicht. Sie können sich Entwickler als Kunden vorstellen, die Ihre APIs verwenden.

Entwickler müssen in Ihrer Organisation registriert sein, bevor sie eine App registrieren und einen API-Schlüssel für den Zugriff auf Ihre APIs erhalten können. Als API-Anbieter können Sie Entwickler in Ihrer Organisation hinzufügen, aktualisieren oder entfernen. Sie können sie manuell über die UI hinzufügen, ein Entwicklerportal erstellen, um sie über eine Website zu registrieren, oder einen eigenen Registrierungsmechanismus mithilfe der Apigee API definieren.

Apigee App (oder App)

Entwickler erstellen eine oder mehrere Clientanwendungen, die Ihre APIs nutzen.

Entwickler, die Clientanwendungen erstellen, die APIs aufrufen, die eine Prüfung der Anmeldedaten benötigen (z. B. API-Schlüssel oder OAuth-Token), müssen zuerst eine App-Registrierung in Ihrer Organisation erstellen. Bei einer App-Registrierung werden dem Entwickler der API-Schlüssel, ein Schlüssel/Secret-Paar oder andere Anmeldedaten zur Verfügung gestellt, die verwendet werden müssen, wenn die Clientanwendung Ihre APIs aufruft.

Da alle Anwendungen in Ihrer Organisation registriert sind, können Sie mit Apigee Analyseinformationen zur Anwendung selbst und zu deren Nutzung Ihrer APIs beobachten und erfassen.

Zusätzliche Komponenten von Apigee, die nicht angezeigt werden, sind die API-Schlüssel und OAuth-Tokens.

Apigee unterstützt verschiedene Authentifizierungsmethoden wie einen einfachen API-Schlüssel, zweibeiniges OAuth, dreibeiniges OAuth und andere.

Wenn der API-Anbieter die API-Schlüsselüberprüfung als Autorisierungsmechanismus angibt, muss die Clientanwendung bei jeder Anfrage an Ihre APIs einen API-Schlüssel übergeben. Wenn dieser Schlüssel gültig ist, lässt Apigee die Anfrage zu. Wenn der API-Anbieter die OAuth-Token-Verifizierung als Autorisierungsmechanismus angibt, muss die Clientanwendung auch zuerst ein OAuth-Token abrufen und dieses Token dann bei jeder Anfrage an Ihre APIs übergeben. Wenn dieses Token gültig ist, lässt Apigee die Anfrage zu. Andere benutzerdefinierte Autorisierungsschemas sind möglich.

Als API-Anbieter müssen Sie festlegen, wie Entwickler ihre Apps registrieren. Jeder App-Registrierung sind ein oder mehrere Schlüssel oder Anmeldedaten zugeordnet. Wenn Sie Entwicklern erlauben, ihre eigenen Anwendungen über ein Entwicklerportal zu registrieren, kann der Entwickler den Schlüssel oder die Anmeldedaten, die für den Zugriff auf Ihre APIs erforderlich sind, über ein praktisches Self-Service-Erlebnis abrufen.

Bei der Registrierung der App kann der Entwickler auf ein einzelnes API-Produkt oder auf mehrere API-Produkte zugreifen. Die App eines Entwicklers verwendet für den Zugriff auf alle API-Produkte, die mit der Anwendung verknüpft sind, dieselben Schlüssel/Anmeldedaten.

Sie können den Schlüssel jederzeit widerrufen, sodass die Anwendung des Entwicklers nicht mehr auf Ihre APIs zugreifen kann. Die registrierte Darstellung der Anwendung des Entwicklers ist jedoch weiterhin in Ihrer Organisation vorhanden. Alternativ können Sie eine Ablaufzeit für einen Schlüssel definieren, sodass der Entwickler den Schlüssel nach einer bestimmten Zeit aktualisieren muss.

Apigee-Nutzer

Apigee-Nutzer bilden das API-Team der Organisation, zu dem beispielsweise Administratoren, API-Proxy- und API-Produktersteller oder Nutzer, die Analysen und andere Statistiken überwachen. Endnutzer sind Personen, die die Anwendungen verwenden, die von Apigee-Entwicklern erstellt werden. In den meisten Fällen wird in dieser Dokumentation der Begriff "Nutzer" verwendet, um auf einen Apigee-Nutzer zu verweisen.

Administratoren können einer Organisation Nutzer hinzufügen.

Unterschiedliche Nutzer haben unterschiedliche Rollen und Zugriffsberechtigungen. Beispiel: Manche Nutzer sind Organisationsadministratoren und Betriebsadministratoren mit Berechtigungen zum Ändern der Organisation und ihrer Komponenten. Definieren Sie andere Nutzer mit Berechtigungen zum Erstellen von API-Proxys und API-Produkten, jedoch ohne die Berechtigung, andere Nutzer zu ändern.

Nutzer können Mitglieder mehrerer Organisationen sein. Beispielsweise könnte Ihr Unternehmen mehrere Organisationen auf Apigee definieren, um verschiedene Entwickler-Communitys zu unterstützen, auch wenn intern dieselben Personen alle API-Proxys und API-Produkte erstellen und daher Mitglieder Ihrer Organisationen sind.

Sie müssen keine Apigee-Organisation erstellen, um Nutzer zu werden. Ein Administrator kann Sie zu einer vorhandenen Organisation hinzufügen.

Alle Nutzer melden sich hier in Apigee an: Apigee-Benutzeroberfläche.

Berechtigungen

Die Organisationsberechtigungen hängen davon ab, ob die kostenpflichtige Organisation ein Abo- oder Pay as you go-Preismodell verwendet.

Aboberechtigungen

Organisationen:Die Organisationsberechtigung wird in Einheiten ausgedrückt. Wenn Sie eine Berechtigung für eine Organisationseinheit erhalten, können Sie damit eine einzelne neue Organisation in jeder beliebigen Region aktivieren oder eine vorhandene Organisation durch die Erweiterung der Domainnamen auf eine einzelne neue Region erweitern. Eine Organisation in N Regionen nutzt N Organisationseinheiten. Wenn Sie beispielsweise vier neue Organisationseinheiten erwerben, können Sie:

  • eine bestehende Organisation auf vier neue Regionen erweitern
  • oder jede von 2 vorhandenen Organisationen auf zwei neue Regionen erweitern
  • oder vier neue Organisationen erstellen, die jeweils in einer Region verfügbar sind.

Die Gesamtberechtigung für Ihre Organisationseinheit ist die Summe Ihrer Abostufe plus der relevanten Organisationspakete.

Umgebungen: Umgebungsberechtigungen werden auch in Einheiten ausgedrückt. Sie sind unabhängig von den Organisationsberechtigungen und verhalten sich anders. Die Verwendung einer Umgebungseinheitsberechtigung erfolgt in zwei Schritten: Zuerst erstellen Sie eine Umgebung und fügen diese dann zu einer Organisation hinzu. Eine Umgebung wird auf die Berechtigung Ihrer Umgebungseinheit angerechnet, wenn die Umgebung an eine Organisation angehängt wurde.

Die Nutzung der Umgebungseinheiten wird als Anzahl der Umgebungen berechnet, die in allen Organisationen und Regionen verwendet werden. Mit anderen Worten: Eine Umgebung, die in zwei Regionen für eine Organisation bereitgestellt wird, verbraucht zwei Umgebungseinheiten von Ihrer Berechtigung.

Die Gesamtberechtigung für Ihre Umgebungseinheit ist die Summe der Berechtigung, die in Ihrer Abostufe bereitgestellt wird, sowie zusätzliche Berechtigung, die Sie über die Umgebung oder Organisationspakete erhalten. Durch den Kauf eines Organisationspakets erhalten Sie eine Organisationseinheit und eine Reihe von Umgebungseinheiten. Jede Berechtigung für Umgebungseinheiten, die über ein Organisationspaket hinzugefügt wird, ist unabhängig von der Organisation, die Sie erstellen oder erweitern. Berechtigungen für Umgebungseinheiten, die über Organisationspakete hinzugefügt wurden, fügen einfach die Gesamtberechtigung für Ihre Umgebungseinheit hinzu. Wenn Sie weitere Umgebungseinheiten hinzufügen möchten, ohne weitere Organisationseinheiten zu erwerben, können Sie ein Umgebungspaket kaufen.

Weitere Informationen finden Sie unter Aboberechtigungen.

Pay as you go – Berechtigungen

Organisationen: Das „Pay as you go“-Preismodell berechtigt Kontoinhaber zu einer einzigen Organisation.

Umgebungen: Umgebungsberechtigungen sind unabhängig von Organisationsberechtigungen. Sie verhalten sich auch anders als Organisationsberechtigungen, da zu ihrer Verwendung zwei Schritte ausgeführt werden müssen: Sie erstellen zuerst eine Umgebung und fügen diese dann zu einer Organisation hinzu. Umgebungen werden erst auf Ihre Berechtigungslimits angerechnet, wenn sie einer Organisation hinzugefügt wurden.

Anders ausgedrückt: Die Anzahl der Umgebungen, die auf Ihre Berechtigung angerechnet werden, entspricht der Anzahl der Umgebungen, die einer Organisation zugeordnet wurden.

Das „Pay as you go“-Preismodell umfasst eine Berechtigung von 85 Umgebungen in allen Regionen.

Weitere Informationen finden Sie unter „Pay as you go”-Berechtigungen.