Integrationsstatus und ‑einstellungen prüfen

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zuApigee X wechseln. info

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

Einstellungen der API-Hub-Connector-Integration prüfen

Wenn Sie die Einstellungen der 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"

Dabei gilt:

• ORG_NAME ist der Name Ihrer Apigee Edge-Organisation.
• OAUTH_TOKEN ist 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.

"gatewayId" zeigt den Instanzressourcennamen an, mit dem diese Apigee Edge-Organisation verbunden ist.

Zusammengefassten Status prüfen

Wenn Sie einen zusammengefassten 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

Dabei gilt:

• ORG_NAME ist der Name Ihrer Apigee Edge-Organisation.

Eine erfolgreiche zusammengefasste Antwort sieht in etwa so aus und zeigt den Upload-Fortschritt für Proxys und Umgebungen: Im folgenden Beispiel wird die Phase Queued angezeigt:

{
  "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
      }
    }
  }
}

Felder für den zusammengefassten Status

Detaillierten Upload-Status 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 wurden, mit dem Endpunkt /details und Suchparametern prüfen.

Status für ein bestimmtes Element

Verwenden Sie die Abfrageparameter filter und name, um den detaillierten Status eines bestimmten Elements zu prüfen. 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

Der Aufruf der oben genannten API führt zu einer JSON-Ausgabe ähnlich der folgenden für einen Proxy, der vor Kurzem hochgeladen wurde:

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

Detaillierter Status mit Revisionsinformationen

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

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

Der Aufruf der oben genannten API mit dem Parameter showrevisions führt zu einer JSON-Ausgabe ähnlich der folgenden:

{
  "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 Gruppen-Uploads

Sie können Upload-Status für eine Gruppe von Elementen 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

Rufen Sie die Status API so auf, um eine detaillierte Liste aller Umgebungen abzurufen, für die in der Organisation acme ein Upload pending ist:

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 Statuselemente, 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 den detaillierten Status

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

Parameterkombinationen für den detaillierten Status

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