Integrationsstatus und ‑einstellungen prüfen

Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen. info

Auf dieser Seite wird beschrieben, wie Sie den Status und die Einstellungen der Integration des Apigee Edge API-Hub-Connectors in Ihrer Apigee Edge-Organisation prüfen, nachdem sie aktiviert wurde.

Einstellungen für die Integration von API-Hub-Connectors prüfen

Wenn Sie die Einstellungen für die API-Hub-Connector-Integration für eine Organisation abrufen möchten, senden Sie eine GET-Anfrage mit der folgenden Anfrage:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee Edge-Organisation.
  • OAUTH_TOKENist das OAuth-Token, das zur Authentifizierung der Anfrage verwendet wird. Weitere Informationen zum Erstellen eines OAuth-Tokens finden Sie unter Tokens abrufen.

Eine erfolgreiche Antwort sieht in etwa so aus:

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true bestätigt, dass die API Hub Connector-Integration für die Organisation aktiviert ist.

Unter "gatewayId" wird der Instanzressourcennamen angezeigt, mit dem diese Apigee Edge-Organisation verbunden ist.

Konsolidierten Status prüfen

Wenn Sie einen konsolidierten Status mit detailliertem Upload-Fortschritt abrufen möchten, senden Sie eine GET-Anfrage an die Edge Management API:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

Wobei:

  • ORG_NAME ist der Name Ihrer Apigee Edge-Organisation.

Eine erfolgreiche konsolidierte Antwort sieht in etwa so aus. Sie zeigt den Uploadfortschritt für Proxys und Umgebungen. Das folgende Beispiel zeigt eine Queued-Phase:

{
  "phase": "Preparing",
  "lastUpdated": "2025-09-15T02:23:50.706Z",
  "components": {
    "proxy": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 10,
        "pendingItems": 1,
        "completedItems": 9,
        "failedItems": 0
      }
    },
    "environment": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 5,
        "pendingItems": 0,
        "completedItems": 4,
        "failedItems": 1
      }
    }
  }
}

Konsolidierte Statusfelder

Feld Description
phase Die aktuelle Verarbeitungsphase für die Organisation. Folgende Werte sind möglich:
  • Queued: Die Organisation wurde vor Kurzem hinzugefügt und wird für die Erstverarbeitung in die Warteschlange gestellt.
  • Preparing: Die Organisation befindet sich in einem Cold-Transfer-Status, in dem alle vorhandenen Proxys in den API-Hub hochgeladen werden. Dieser Status tritt auf, wenn die Organisation vor Kurzem hinzugefügt wurde und vorbereitet wird.
  • Processing: Die Organisation befindet sich in einem kontinuierlichen Aktualisierungsstatus, in dem Änderungen an Proxys und Umgebungen kontinuierlich in den API-Hub hochgeladen werden.
lastUpdated Der Zeitstempel des letzten Ereignisses, das für diese Organisation verarbeitet wurde.
components Eine Karte mit detaillierten Informationen zu den verarbeiteten Proxys und Umgebungen. Die Karte kann die folgenden Schlüssel enthalten:
  • proxy: Enthält detaillierte Angaben zur Anzahl der API-Proxys im Edge-System, die verarbeitet und in den API-Hub hochgeladen wurden.
  • environment: Enthält detaillierte Angaben zur Anzahl der Umgebungen im Edge-System, die verarbeitet und in den API-Hub hochgeladen wurden.
progress Die Werte in den Abschnitten proxy oder environment sind:
  • totalItems: Die Gesamtzahl der Artikel.
  • pendingItems: Die Anzahl der Elemente, die noch verarbeitet werden müssen.
  • completedItems: Die Anzahl der Elemente, die erfolgreich abgeschlossen wurden.
  • failedItems: Die Anzahl der Elemente, bei denen der Upload fehlgeschlagen ist.

Detaillierten Uploadstatus prüfen

Sie können den detaillierten Status eines einzelnen API-Proxys oder einer einzelnen Umgebung oder einer Gruppe von Elementen, die nach Status gefiltert sind, mit dem Endpunkt /details und Abfrageparametern prüfen.

Status für ein bestimmtes Element

Wenn Sie den detaillierten Status eines bestimmten Elements prüfen möchten, verwenden Sie die Abfrageparameter filter und name. Rufen Sie die Status-API für einen API-Proxy mit dem Namen myproxy in der Organisation acme so auf:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

Rufen Sie die Status-API für eine Umgebung mit dem Namen myenv in der Organisation acme so auf:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

Wenn Sie die oben genannte API aufrufen, erhalten Sie für einen kürzlich hochgeladenen Proxy eine JSON-Ausgabe, die der folgenden ähnelt:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

Detaillierter Status mit Überarbeitungsinformationen

Sie können Informationen zur einzelnen Proxy-Revision für einen bestimmten Proxy abrufen, indem Sie einen zusätzlichen Abfrageparameter showRevisions=true angeben. Die hier generierte Ausgabe enthält Details zu jeder Überarbeitung, die für einen bestimmten Proxy hochgeladen wurde.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

Wenn Sie die oben genannte API mit dem Parameter showrevisions aufrufen, erhalten Sie eine JSON-Ausgabe, die der folgenden ähnelt:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
  "revisions": [
    {
      "name": "1",
      "status": "Up to date",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
    },  
    {
      "name": "2",
      "status": "Pending upload",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:55.000Z",
    }  
  ]
}

Status des Gruppenuploads

Sie können den Uploadstatus für eine Gruppe von Artikeln abrufen, indem Sie Gruppenfilter mit dem Abfrageparameter state verwenden.

Rufen Sie die Status-API so auf, um den Status aller API-Proxys abzurufen, die sich in der Organisation acme im Status failed befinden:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&state=failed

Wenn Sie eine detaillierte Liste aller Umgebungen abrufen möchten, für die in der Organisation acme ein Upload aussteht, rufen Sie die Status-API so auf:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&state=pending

Das Ergebnis des Aufrufs dieser API ist eine JSON-Sammlung einzelner Status-Elemente, die dem Filter entsprechen. Beispiel:

[
  {
    "name": "myProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:50.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:50.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  },
  {
    "name": "secondProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:51.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:51.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  }
]

Abfrageparameter für detaillierten Status

Die API bietet drei Abfrageparameter. Bei den Werten wird die Groß-/Kleinschreibung beachtet.

Abfrageparameter Mögliche Werte Description
filter proxy, environment Dieser Abfrageparameter gibt an, dass die Ergebnisse nach einem Proxy oder einer Umgebung gefiltert werden müssen.
state failed, pending, all Dieser Abfrageparameter gibt an, dass die Ergebnisse zusätzlich zu filter nach Bundesstaat gefiltert werden müssen.
name Der Name des jeweiligen Artikels Dieser Abfrageparameter gibt an, dass die Ergebnisse zusätzlich zu filter nach Namen gefiltert werden müssen.
showrevisions true, false Wenn dieser Abfrageparameter angegeben wird, wird der Überarbeitungsstatus in der Ausgabe generiert (nur gültig, wenn filter=proxy).

Parameterkombinationen für detaillierten Status

In der folgenden Tabelle werden die möglichen Parameterkombinationen erläutert, die an die REST API übergeben werden können, um einen detaillierten Status zu erhalten. NA gibt an, dass der Parameter ignoriert wird. NULL gibt an, dass der Parameter nicht angegeben wurde.

filtern Bundesstaat name Ergebnisse
proxy all NULL Statusdetails für alle Proxys melden.
proxy failed NULL Berichtsstatusdetails für alle Proxys, die nicht hochgeladen werden konnten.
proxy pending NULL Statusdetails für alle Proxys, die noch hochgeladen oder neu hochgeladen werden müssen.
proxy NULL myproxy Statusdetails für einen Proxy namens myproxy melden.
proxy NON-NULL NON-NULL Gibt einen Fehler zurück.
environment all NULL Details zum Berichtsstatus für alle Umgebungen
environment failed NULL Berichtsstatusdetails für alle Umgebungen, bei denen der Upload fehlgeschlagen ist.
environment pending NULL Statusdetails für alle Umgebungen, die noch hochgeladen oder neu hochgeladen werden müssen.
environment NULL myenv Berichte Statusdetails für eine Umgebung namens myenv.
environment NON-NULL NON-NULL Gibt einen Fehler zurück.