API-Ressourcen mit Apigee Spaces verwalten

Apigee Edge-Dokumentation aufrufen

In diesem Thema wird beschrieben, wie API-Ressourcen in einem Space erstellt und verwaltet werden. Sie können API-Proxys, freigegebene Abläufe und API-Produkte in einem Space erstellen. Ressourcen, die im Space erstellt wurden, erben die gleichen Berechtigungen wie der Space.

Das Erstellen von Ressourcen in einem Space entspricht dem Erstellen von Ressourcen in einer Apigee-Organisation, mit der Ausnahme, dass Sie beim Erstellen der Ressource einen Space auswählen können. Für die Private GA-Version können Sie API-Ressourcen über die Befehlszeile mit den Apigee APIs oder mit Apigee in der Cloud Console erstellen.

In diesem Leitfaden werden die Schritte für Folgendes beschrieben:

Eine Übersicht über Apigee Spaces finden Sie unter Apigee Spaces.

Weitere Informationen zu den Ressourcentypen der Apigee API finden Sie unter:

Hinweise

Bevor Sie API-Ressourcen in Apigee Spaces erstellen, müssen Sie die folgenden Aufgaben erledigt haben:

  • Sie haben Ihre Apigee-Abo- oder „Pay as you go“-Organisation bereitgestellt. Weitere Informationen zu den erforderlichen Schritten zum Bereitstellen von Apigee finden Sie unter Apigee einrichten.
  • Sie haben einen Space in Ihrer Apigee-Organisation erstellt. Weitere Informationen finden Sie unter Apigee Space erstellen.
  • Mitglieder wurden einem Space zugewiesen. Weitere Informationen finden Sie unter Mitglieder und Rollen in einem Space verwalten.

Erforderliche Rollen und Berechtigungen

Mit der Einführung von Apigee-Spaces hat sich die Art und Weise geändert, wie IAM die Berechtigungen prüft, die für die Ausführung einiger Vorgänge auf API-Ressourcen erforderlich sind. Wenn die API-Ressource in einem Space vorhanden ist, prüft IAM auf Space-Ebene, ob das Space-Mitglied, das den Vorgang ausführt, die entsprechenden Berechtigungen hat. Die erforderlichen Berechtigungen für diese Vorgänge, bei denen sich API-Ressourcen in einem Space befinden, werden unten beschrieben:

Vorgang Berechtigung erforderlich Umfang
API-Proxy bereitstellen
apigee.deployments.create
UND
apigee.proxyrevisions.deploy
Umgebung
 
API-Proxy
Alle Bereitstellungen eines API-Proxys auflisten apigee.proxies.get API-Proxy
Alle Bereitstellungen einer API-Proxy-Version auflisten apigee.proxyrevisions.get API-Proxy-Version
Alle Bereitstellungen eines API-Proxys in einer Umgebung auflisten
apigee.deployments.list
ODER
apigee.proxies.get
Umgebung
 
API-Proxy
Bereitstellung einer API-Proxy-Version abrufen
apigee.deployments.get
ODER
apigee.proxyrevisions.get
API-Proxy-Version
 
Umgebung
API-Proxy-Version löschen apigee.deployments.delete API-Proxy-Version UND Umgebung
Freigegebenen Ablauf bereitstellen
apigee.deployments.create
UND
apigee.sharedflows.deploy
Umgebung
 
Freigegebene Abläufe
Alle Bereitstellungen eines freigegebenen Ablaufs auflisten apigee.sharedflows.get Freigegebene Abläufe
Alle Bereitstellungen der Version eines freigegebenen Ablaufs auflisten apigee.sharedflowrevisions.get Version eines freigegebenen Ablaufs
Alle Bereitstellungen eines freigegebenen Ablaufs in einer Umgebung auflisten
apigee.deployments.list
ODER
apigee.sharedflows.get
Umgebung
 
Freigegebene Abläufe
Bereitstellung der Version eines freigegebenen Ablaufs abrufen
apigee.deployments.get
ODER
apigee.sharedflowrevisions.get
API-Proxy-Version
 
Freigegebene Abläufe
Freigegebenen Ablauf löschen apigee.deployments.delete Freigegebener Ablauf UND Umgebung
Debugsitzung für eine API-Proxy-Version erstellen apigee.tracesessions.create API-Proxy-Version UND Umgebung
Debugsitzung abrufen apigee.tracesessions.get API-Proxy UND Umgebung
Daten aus einer Debug-Sitzung löschen apigee.tracesessions.delete API-Proxy UND Umgebung
Aktive Debugsitzungen in der API-Proxy-Version auflisten apigee.tracesessions.list Umgebung ODER API-Proxy-Version
Fehlerbehebungsdaten aus einer Transaktion abrufen apigee.tracesessions.get Umgebung UND API-Proxy-Version
Transaktions-IDs aus einer Debugsitzung auflisten apigee.tracesessions.get Umgebung UND API-Proxy-Version

Mitgliedern von Spaces Rollen und Berechtigungen zuweisen

Die verschiedenen beschriebenen Berechtigungen sind entweder in der Rolle apigee.apiAdminV2 oder in der Rolle apigee.environmentAdmin enthalten. Weitere Informationen finden Sie unter Apigee-Rollen.

So weisen Sie diese Rollen und ihre Berechtigungen einem Space-Mitglied zu:

  • Fügen Sie dem Space mithilfe der API die Rolle roles/apiAdminV2 und der Zielumgebung mithilfe der API die Rolle roles/environmentAdmin hinzu.
  • Fügen Sie die Rollen dem Projekt über die IAM-Benutzeroberfläche hinzu.

Auf Rollen prüfen

  1. Öffnen Sie in der Google Cloud Console die Seite IAM.

    IAM aufrufen
  2. Wählen Sie das Projekt aus.
  3. Suchen Sie in der Spalte Hauptkonto nach allen Zeilen, in denen Sie oder eine Gruppe, zu der Sie gehören, angegeben sind. Fragen Sie Ihren Administrator, zu welchen Gruppen Sie gehören.

  4. Prüfen Sie in allen Zeilen, in denen Sie angegeben oder enthalten sind, die Spalte Rolle, um zu sehen, ob die Liste der Rollen die erforderlichen Rollen enthält.

So weisen Sie die Rollen zu:

  1. Öffnen Sie in der Google Cloud Console die Seite IAM.

    Zu IAM
  2. Wählen Sie das Projekt aus.
  3. Klicken Sie auf Zugriff erlauben.
  4. Geben Sie im Feld Neue Hauptkonten Ihre Nutzer-ID ein. Dies ist in der Regel die E-Mail-Adresse eines Google-Kontos.

  5. Wählen Sie in der Liste Rolle auswählen eine Rolle aus.
  6. Wenn Sie weitere Rollen zuweisen möchten, klicken Sie auf Weitere Rolle hinzufügen und fügen Sie weitere Rollen hinzu.
  7. Klicken Sie auf Speichern.

Rolle, die für den Zugriff auf API-Ressourcen in der Google Cloud Console erforderlich ist

Damit Nutzer als Mitglied eines Spaces auf die Apigee-Benutzeroberfläche in der Cloud Console zugreifen können, muss ihnen die Rolle ApigeeSpaceUser gewährt werden. Weitere Informationen finden Sie unter IAM-Berechtigungen und ‑Rollen.

API-Proxys in einem Space verwalten

Mitglieder der Apigee-Organisation, die einem Space zugewiesen sind, können API-Proxys als Space-Ressourcen erstellen, bereitstellen und deren Bereitstellung aufheben. Mitglieder, die nur anderen Spaces zugewiesen sind, können nicht auf diese Proxys zugreifen oder sie verwalten.

API-Proxy als Space-Ressource erstellen

Erstellen Sie einen API-Proxy als Space-Ressource mithilfe von Apigee in der Cloud Console oder der API, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

So erstellen Sie einen API-Proxy als Space-Ressource mit Apigee in der Cloud Console:

  1. Folgen Sie der Anleitung unter API-Proxy erstellen.
  2. In Schritt 5 sehen Sie unter Proxy-Details ein zusätzliches Feld, in dem Sie einen Space für den API-Proxy auswählen können. Wählen Sie im Listenfeld einen Space aus. Wenn Sie den API-Proxy keinem Space zuweisen möchten, können Sie dieses Feld überspringen.
  3. Klicken Sie auf Weiter, um mit dem optionalen Bereitstellungsschritt der Proxyerstellung fortzufahren, oder auf Erstellen, um den Proxy zu erstellen, ohne ihn bereitzustellen.

Apigee API

Verwenden Sie den folgenden Befehl, um mit den Apigee APIs einen API-Proxy als Space-Ressource zu erstellen:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/apis?name=PROXY_NAME&space=SPACE_NAME&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@PROXY_BUNDLE"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • PROXY_NAME ist der Name des API-Proxys, den Sie erstellen. Der Name muss global eindeutig sein, nicht nur innerhalb des Spaces eindeutig.
  • SPACE_NAME ist der Name des Space, in dem Sie den API-Proxy erstellen.
  • PROXY_BUNDLE ist der Name der API-Proxy-Bundle-Datei.

Beispiel: Mit dem folgenden Befehl erstellt ein rotes Teammitglied einen API-Proxy mit dem Namen proxy-1 als rote Space-Ressource in der acme-Organisation mit der proxy-bundle.zip-Datei:

curl "https://apigee.googleapis.com/v1/organizations/acme/apis?name=proxy-1&space=red&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data \
    -F "file=@proxy-bundle.zip"

Das folgende Beispiel zeigt die Antwort auf den Befehl:

{
  "basepaths": ["/proxy-1"],
  "revision": 1,
  "apiProxyId": "proxy-1",
  "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
  "space": "red",
  "createTime": ...,
  "updateTime": ...
}

API-Proxy als Space-Ressource bereitstellen

Stellen Sie über Apigee in der Cloud Console oder die API einen API-Proxy als Space-Ressource bereit, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

Wenn Sie einen API-Proxy als Space-Ressource mit Apigee in der Cloud Console bereitstellen möchten, folgen Sie der Anleitung unter API-Proxy bereitstellen. Es sind keine zusätzlichen Schritte oder Felder erforderlich.

Apigee API

Verwenden Sie den folgenden Befehl, um einen API-Proxy mithilfe der Apigee APIs als Space-Ressource bereitzustellen:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/apis/PROXY_NAME/revisions/REVISION_NUMBER/deployments" \
          -X POST -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • ENV_NAME ist der Name der Umgebung, in der Sie den API-Proxy bereitstellen.
  • PROXY_NAME ist der Name des API-Proxys, den Sie bereitstellen.
  • REVISION_NUMBER ist die Versionsnummer des API-Proxys, den Sie bereitstellen.

Mit dem folgenden Befehl stellt ein rotes Teammitglied beispielsweise den API-Proxy proxy-1, Version 1, in der acme-Organisation für die prod-Umgebung bereit:

curl "https://apigee.googleapis.com/v1/organizations/acme/environments/prod/apis/proxy-1/revisions/1/deployments" \
          -X POST -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Das folgende Beispiel zeigt die Antwort auf den Befehl:

      {
        "environment": "prod",
        "revision": "1",
        "apiProxy": "proxy-1",
        ...
      }
      

Bereitstellung eines mit einem Space verknüpften API-Proxys aufheben

Heben Sie die Bereitstellung eines API-Proxys, der mit einem Space verknüpft ist, über Apigee in der Cloud Console oder die API auf, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

Wenn Sie die Bereitstellung eines API-Proxys aufheben möchten, der mit einem Space verknüpft ist, und Apigee in der Cloud Console verwenden, folgen Sie der Anleitung unter Bereitstellung eines API-Proxys aufheben. Es sind keine weiteren Schritte oder Felder erforderlich.

Apigee API

Verwenden Sie den folgenden Befehl, um über die Apigee APIs die Bereitstellung eines API-Proxys aufzuheben, der mit einem Space verknüpft ist:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/apis/PROXY_NAME/revisions/REVISION_NUMBER/deployments" \
          -X DELETE -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • ENV_NAME ist der Name der Umgebung, in der Sie die Bereitstellung des API-Proxys aufheben.
  • PROXY_NAME ist der Name des API-Proxys, dessen Bereitstellung Sie aufheben.
  • REVISION_NUMBER ist die Versionsnummer des API-Proxys, dessen Bereitstellung Sie rückgängig machen.

Mit dem folgenden Befehl hebt ein rotes Teammitglied beispielsweise die Bereitstellung des API-Proxys proxy-1, Version 1, in der acme-Organisation aus der prod-Umgebung auf:

curl "https://apigee.googleapis.com/v1/organizations/acme/environments/prod/apis/proxy-1/revisions/1/deployments" \
          -X DELETE -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Freigegebene Abläufe als Space-Ressourcen verwalten

Mitglieder, die einem Space zugewiesen sind, können auch freigegebene Abläufe als Space-Ressourcen erstellen, bereitstellen und deren Bereitstellung aufheben. Mitglieder anderer Spaces können nicht auf diese freigegebenen Workflows zugreifen oder sie verwalten.

Freigegebenen Ablauf als Space-Ressource erstellen

Erstellen Sie mit Apigee in der Cloud Console oder der API einen freigegebenen Ablauf als Space-Ressource, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

So erstellen Sie mithilfe von Apigee in der Cloud Console einen freigegebenen Ablauf als Space-Ressource:
  1. Folgen Sie der Anleitung unter Freigegebenen Ablauf in der Apigee-Benutzeroberfläche erstellen, um einen freigegebenen Ablauf von Grund auf neu zu erstellen oder ein vorhandenes Ablauf-Bundle hochzuladen.
  2. In Schritt 4 sehen Sie im Dialogfeld Freigegebenen Ablauf erstellen ein zusätzliches Feld, in dem Sie einen Space für den API-Proxy auswählen können. Wählen Sie im Listenfeld einen Space aus. Wenn Sie den API-Proxy keinem Space zuweisen möchten, können Sie dieses Feld überspringen.
  3. Klicken Sie auf Erstellen, um den freigegebenen Ablauf zu erstellen.

Apigee API

Verwenden Sie den folgenden Befehl, um mit den Apigee APIs einen freigegebenen Ablauf als Space-Ressource zu erstellen:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/sharedflows?name=FLOW_NAME&space=SPACE_NAME&action=import" \
          -X POST -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: multipart/form-data" \
          -F "file=@SHARED_FLOW_BUNDLE"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • FLOW_NAME ist der Name des freigegebenen Ablaufs, den Sie erstellen. Der Name muss global eindeutig sein, nicht nur innerhalb des Spaces eindeutig.
  • SPACE_NAME ist der Name des Spaces, in dem Sie den freigegebenen Ablauf erstellen.
  • SHARED_FLOW_BUNDLE ist der Name der Bundle-Datei des freigegebenen Ablaufs.

Mit dem folgenden Befehl erstellt ein Mitglied des roten Teams beispielsweise einen freigegebenen Ablauf namens flow-1, der mit dem roten Space in der Organisation acme verknüpft ist:

curl "https://apigee.googleapis.com/v1/organizations/acme/sharedflows?name=flow-1&space=red&action=import" \
          -X POST -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: multipart/form-data" \
          -F "file=@sharedflow-bundle.zip"

Das folgende Beispiel zeigt die Antwort auf den Befehl:

      {
        "name": "organizations/acme/sharedflows/flow-1",
        "revision": 1,
        "sharedFlowId": "flow-1",
        "space": "red",
        "createTime": ...,
        "updateTime": ...
      }
      

Freigegebenen Ablauf als Space-Ressource bereitstellen

Stellen Sie mit der Apigee Console in der Cloud oder der API einen freigegebenen Ablauf als Space-Ressource bereit, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

So stellen Sie mit Apigee in der Cloud Console einen freigegebenen Ablauf als Space-Ressource bereit:

  1. Melden Sie sich in der Apigee-UI in der Cloud Console an.
  2. Wählen Sie die Organisation aus, die den freigegebenen Ablauf enthält. Weitere Informationen finden Sie unter Zwischen Organisationen wechseln.
  3. Wählen Sie in der linken Navigationsleiste Proxy-Entwicklung > Freigegebene Abläufe aus.
  4. Klicken Sie auf der Übersichtsseite Freigegebene Abläufe auf den Namen des freigegebenen Ablaufs, den Sie bereitstellen möchten. Die Detailseite für den freigegebenen Ablauf wird angezeigt.
  5. Klicken Sie auf Bereitstellen, um das Dialogfeld für die Bereitstellung zu öffnen.
  6. Geben Sie Folgendes ein:
    • Version: Die Versionsnummer des freigegebenen Ablaufs, den Sie bereitstellen möchten.
    • Umgebung: Die Umgebung, in der Sie den freigegebenen Ablauf bereitstellen möchten.
    • Dienstkonto (optional): Ein Dienstkonto für den freigegebenen Ablauf.
  7. Klicken Sie auf Bereitstellen.

Apigee API

Verwenden Sie den folgenden Befehl, um mithilfe der Apigee APIs einen freigegebenen Ablauf als Space-Ressource bereitzustellen:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/sharedflows/FLOW_NAME/revisions/REVISION_NUMBER/deployments" \
          -X POST -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • ENV_NAME ist der Name der Umgebung, in der Sie den freigegebenen Ablauf bereitstellen.
  • FLOW_NAME ist der Name des freigegebenen Ablaufs, den Sie bereitstellen.
  • REVISION_NUMBER ist die Versionsnummer des freigegebenen Ablaufs, den Sie bereitstellen.

Mit dem folgenden Befehl stellt ein Mitglied des roten Teams beispielsweise den freigegebenen Ablauf flow-1, Version 1, in der Organisation acme in der Umgebung prod bereit:

curl "https://apigee.googleapis.com/v1/organizations/acme/environments/prod/sharedflows/flow-1/revisions/1/deployments" \
          -X POST -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Das folgende Beispiel zeigt die Antwort auf den Befehl:

      {
        "environment": "prod",
        "revision": "1",
        "sharedFlow": "flow-1",
        ...
      }
      

Bereitstellung eines freigegebenen Ablaufs, der mit einem Space verknüpft ist, aufheben

Heben Sie über die Apigee Console in der Cloud oder die API die Bereitstellung eines mit einem Space verknüpften freigegebenen Ablaufs auf, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

So heben Sie mit Apigee in der Cloud Consoledie Bereitstellung eines freigegebenen Ablaufs auf, der mit einem Space verknüpft ist:

  1. Melden Sie sich in der Apigee-UI in der Cloud Console an.
  2. Wählen Sie die Organisation aus, die den freigegebenen Ablauf enthält. Weitere Informationen finden Sie unter Zwischen Organisationen wechseln.
  3. Wählen Sie in der linken Navigationsleiste Proxy-Entwicklung > Freigegebene Abläufe aus.
  4. Klicken Sie auf der Übersichtsseite Freigegebene Abläufe auf den Namen des freigegebenen Ablaufs, dessen Bereitstellung Sie aufheben möchten. Die Detailseite für den freigegebenen Ablauf wird angezeigt.
  5. Klicken Sie unter Bereitstellungen auf Bereitstellung aufheben.

Apigee API

Verwenden Sie den folgenden Befehl, um die Bereitstellung eines freigegebenen Ablaufs aufzuheben, der mit einem Space verknüpft ist:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/sharedflows/FLOW_NAME/revisions/REVISION_NUMBER/deployments" \
          -X DELETE -H "Authorization: Bearer $TOKEN" \
          -H "Content-type: application/json"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • ENV_NAME ist der Name der Umgebung, in der Sie die Bereitstellung des freigegebenen Ablaufs aufheben.
  • FLOW_NAME ist der Name des freigegebenen Ablaufs, den Sie nicht mehr bereitstellen möchten.
  • REVISION_NUMBER ist die Versionsnummer des freigegebenen Ablaufs, den Sie zurückziehen.

API-Produkt als Space-Ressource verwalten

Mitglieder, die einem Space zugewiesen sind, können ein API-Produkt erstellen, um ihre API-Proxys zu bündeln. Beim Erstellen von API-Produkten können Mitglieder von Spaces alle für sie zugänglichen API-Proxys auswählen, einschließlich Proxys, die direkt unter der Organisation erstellt wurden, und API-Proxys, die als Ressourcen in Spaces erstellt wurden, in denen sie Mitglied sind. Mitglieder anderer Spaces können nicht auf diese API-Produkte zugreifen oder sie verwalten.

Erstellen Sie mithilfe von Apigee in der Cloud Console oder mit der API ein API-Produkt als Space-Ressource, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

So erstellen Sie ein API-Produkt als Space-Ressource mit Apigee in der Cloud Console:

  1. Folgen Sie der Anleitung unter API-Produkt erstellen.
  2. In Schritt 4 sehen Sie auf der Seite Produktdetails ein zusätzliches Feld, in dem Sie einen Space für das API-Produkt auswählen können. Wählen Sie im Listenfeld einen Space aus. Wenn Sie das API-Produkt keinem Space zuweisen möchten, können Sie dieses Feld überspringen.
  3. Geben Sie die restlichen Konfigurationsinformationen ein und klicken Sie auf Speichern.

Apigee API

Verwenden Sie den folgenden Befehl, um ein API-Produkt als Space-Ressource zu erstellen:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/apiproducts" \
            -X POST -H "Authorization: Bearer $TOKEN" \
            -H "Content-type: application/json" \
            -d  \
              `{
                "name": "PRODUCT_NAME",
                "displayName": "DISPLAY_NAME",
                "description": "PRODUCT_DESCRIPTION",
                "approvalType": "auto",
                "apiResources": [
                  {
                    "apiproduct": "PRODUCT_NAME",
                    "apiResource": "PROXY_NAME",
                    "operations": [
                      {
                        "method": "GET",
                        "path": "/"
                      }
                    ]
                  }
                ],
                "space": "SPACE_NAME"
              }`

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • PRODUCT_NAME ist der Name des API-Produkts, das Sie erstellen. Der Name muss global eindeutig sein, nicht nur innerhalb des Spaces eindeutig.
  • DISPLAY_NAME ist der Name des API-Produkts, das Sie erstellen, wie er in der Benutzeroberfläche angezeigt wird.
  • PRODUCT_DESCRIPTION ist die Beschreibung des API-Produkts, das Sie erstellen.
  • SPACE_NAME ist der Name des Spaces, in dem Sie das API-Produkt erstellen.
  • PROXY_NAME ist der Name des API-Proxys, den Sie dem API-Produkt hinzufügen.

Beispiel: Mit dem folgenden Befehl erstellt ein rotes Teammitglied ein API-Produkt namens product-1, das mit dem roten Space in der acme-Organisation verknüpft ist:

curl "https://apigee.googleapis.com/v1/organizations/acme/apiproducts?name=product-1&space=red&action=import" \
            -X POST -H "Authorization: Bearer $TOKEN" \
            -X "Content-type: application/json" \
            -d  \
              `{
                "name": "product-1",
                "displayName": "product-1",
                "description": "Product 1",
                "apiResources": [
                  {
                    "apiproduct": "product-1",
                    "apiResource": "proxy-1",
                    "operations": [
                      {
                        "method": "GET",
                        "path": "/"
                      }
                    ]
                  }
                ],
                "space": "red"
              }`

Das folgende Beispiel zeigt die Antwort auf den Befehl:

        {
          "name": "organizations/acme/apiproducts/product-1",
          "displayName": "product-1",
          "description": "Product 1",
          "apiResources": [
            {
              "apiproduct": "product-1",
              "apiResource": "proxy-1",
              "operations": [
                {
                  "method": "GET",
                  "path": "/"
                }
              ]
            }
          ],
          "space": "red",
          "createTime": ...,
          "updateTime": ...
        }

Alle API-Ressourcen auflisten, die mit einem Space verknüpft sind

Für alle Listenvorgänge, einschließlich ListApiProxies, ListSharedFlows und ListApiProducts, können Sie einen Namen für den Space angeben, um alle Ressourcen aufzulisten, die mit diesem Space verknüpft sind. Wenn Sie keinen Space-Namen angeben, werden beim Auflisten alle Ressourcen in der Organisation zurückgegeben, auf die Sie Zugriff haben, unabhängig davon, ob diese Ressourcen mit einem Space verknüpft sind.

Zum Ausführen dieser Aufgabe benötigen Sie die Berechtigung apigee.apiResources.list. Diese Berechtigung ist in der Rolle Apigee > Apigee Organization Admin enthalten.

API-Ressourcen auflisten, die mit einem bestimmten Space verknüpft sind

Sie können alle API-Ressourcen, die mit einem bestimmten Space verknüpft sind, in Apigee in der Cloud Console oder mithilfe der API auflisten, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

Wenn Sie in Apigee in der Cloud Console alle API-Ressourcen auflisten möchten, die mit einem bestimmten Space verknüpft sind, öffnen Sie die Übersichtsseite für den entsprechenden Ressourcentyp (API-Proxys, freigegebene Abläufe oder API-Produkte). Wählen Sie im Feld Filter die Option Space aus der Liste aus und geben Sie dann den Namen des Space ein. Die Liste der diesem Space zugewiesenen Ressourcen wird angezeigt. Es werden nur Ressourcen angezeigt, die mit einem Space verknüpft sind, in dem der Nutzer Mitglied ist.

Apigee API

Mit dem folgenden Befehl können Sie alle API-Ressourcen auflisten, die mit einem bestimmten Space verknüpft sind:

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/RESOURCE_TYPE?space=SPACE_NAME"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • RESOURCE_TYPE ist der Typ der Ressource, die Sie auflisten. Gültige Werte sind:
    • apis
    • sharedFlows
    • apiProducts
  • SPACE_NAME ist der Name des Space, in dem Sie die Ressource auflisten.

Mit dem folgenden Befehl listet ein Mitglied des roten Teams beispielsweise alle API-Proxys auf, die mit dem roten Space in der Organisation acme verknüpft sind:

curl -H  "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/acme/apis?space=red"

Das folgende Beispiel zeigt die Antwort auf den Befehl:

      {
        "proxies": [
          {
            "basepaths": "/proxy-1",
            "revision": "1",
            "apiProxyId": "proxy-1",
            "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
            "space": "red",
            "createTime": ...,
            ....
          }
        ]
      }

API-Ressourcen ohne Angabe eines Space auflisten

Sie können in Apigee in der Cloud Console oder mithilfe der API alle API-Ressourcen auflisten, ohne einen Space anzugeben, wie in den folgenden Abschnitten beschrieben.

Apigee in der Cloud Console

Wenn Sie in Apigee in der Cloud Console eine Liste aller API-Ressourcen eines bestimmten Typs unabhängig von der Space-Verknüpfung aufrufen möchten, öffnen Sie die Übersichtsseite für den entsprechenden Ressourcentyp (API-Proxys, freigegebene Abläufe oder API-Produkte). Eine Liste aller verfügbaren Ressourcen wird angezeigt. Es werden nur Ressourcen angezeigt, für die der Nutzer die Berechtigung zum Ansehen hat. Dazu gehören mit einem oder mehreren Spaces verknüpfte Ressourcen, in denen der Nutzer Mitglied ist, oder Ressourcen, die nicht mit einem Space verknüpft sind.

Apigee API

Mit dem folgenden Befehl können Sie API-Ressourcen auch auflisten, ohne einen Space anzugeben:

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/RESOURCE_TYPE"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee-Organisation.
  • RESOURCE_TYPE ist der Typ der Ressource, die Sie auflisten. Gültige Werte sind:
    • apis
    • sharedFlows
    • apiProducts

Ein Nutzer mit Organization Admin-Zugriff auf alle Organisationsressourcen kann beispielsweise mit dem folgenden Befehl alle API-Proxys in der Organisation acme auflisten:

curl -H  "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/acme/apis"

Wenn die Organisation acme drei Proxys hat, gibt der Befehl Details zu allen drei Proxys zurück. Beispiel:

      {
        "proxies": [
          {
            "basepaths": "/proxy-1",
            "revision": "1",
            "apiProxyId": "proxy-1",
            "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
            "space": "red",
            "createTime": ...,
            ....
          },
          {
            "basepaths": "/proxy-2",
            "revision": "1",
            "apiProxyId": "proxy-2",
            "resourceName": "organizations/acme/apis/proxy-2/revisions/1",
            "space": "blue",
            "createTime": ...,
            ....
          },
          {
            "basepaths": "/proxy-3",
            "revision": "1",
            "apiProxyId": "proxy-3",
            "resourceName": "organizations/acme/apis/proxy-3/revisions/1",
            "space": "green",
            "createTime": ...,
            ....
          }
        ]
      }

Wenn ein anderer Nutzer, der nur apiAdmin-Zugriff hat, auf Ressourcen im roten Space denselben Befehl verwendet, werden nur Details zu proxy-1 zurückgegeben. Die Antwort würde so aussehen:

      {
        "proxies": [
          {
            "basepaths": "/proxy-1",
            "revision": "1",
            "apiProxyId": "proxy-1",
            "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
            "space": "red",
            "createTime": ...,
            ....
          }
        ]
      }

Nächste Schritte