Controllare lo stato e le impostazioni dell'integrazione

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Questa pagina descrive come controllare lo stato e le impostazioni dell'integrazione del connettore dell'hub API Apigee Edge nella tua organizzazione Apigee Edge dopo che è stata abilitata.

Controllo delle impostazioni di integrazione del connettore dell'hub API

Per recuperare le impostazioni di integrazione del connettore dell'hub API per un'organizzazione, invia una richiesta GET:

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

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee Edge.
  • OAUTH_TOKEN è il token OAuth utilizzato per autenticare la richiesta. Per saperne di più sulla creazione di un token OAuth, consulta Recuperare i token.

Una risposta corretta sarà simile alla seguente:

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

"enabled": true conferma che l'integrazione del connettore dell'hub API è attivata per l'organizzazione.

"gatewayId" mostra il nome della risorsa dell'istanza a cui è connessa questa organizzazione Apigee Edge.

Controllo dello stato consolidato

Per uno stato consolidato che includa i dettagli sullo stato di avanzamento del caricamento, invia una richiesta GET all'API di gestione Edge:

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

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee Edge.

Una risposta consolidata corretta sarà simile alla seguente, che mostra lo stato di avanzamento del caricamento per proxy e ambienti. L'esempio seguente mostra una fase Queued:

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

Campi dello stato consolidato

Campo Descrizione
phase La fase di elaborazione attuale per l'organizzazione. I valori possibili sono:
  • Queued: l'organizzazione è stata aggiunta di recente ed è in coda per l'elaborazione iniziale.
  • Preparing: l'organizzazione è in uno stato di trasferimento a freddo in cui tutti i proxy esistenti vengono caricati nell'hub API. Questo stato si verifica quando l'organizzazione è stata aggiunta di recente ed è in fase di preparazione.
  • Processing: l'organizzazione è in uno stato di aggiornamento continuo in cui le modifiche a proxy e ambienti vengono caricate continuamente nell'hub API.
lastUpdated Il timestamp dell'ultimo evento elaborato per questa organizzazione.
components Una mappa che fornisce informazioni dettagliate sui proxy e sugli ambienti elaborati. La mappa può contenere le seguenti chiavi:
  • proxy: fornisce conteggi dettagliati dei proxy API nel sistema Edge che sono stati elaborati e caricati nell'hub API.
  • environment: fornisce conteggi dettagliati degli ambienti nel sistema Edge che sono stati elaborati e caricati nell'hub API.
progress I valori nelle sezioni proxy o environment sono:
  • totalItems: il numero totale di elementi.
  • pendingItems: il numero di elementi in attesa di essere elaborati.
  • completedItems: il numero di elementi completati correttamente.
  • failedItems: il numero di elementi non riusciti durante i caricamenti.

Controllo dello stato di caricamento dettagliato

Puoi controllare lo stato dettagliato di un singolo proxy API o ambiente o di un gruppo di elementi filtrati per stato utilizzando l'endpoint /details e i parametri di query.

Stato di un elemento specifico

Per controllare lo stato dettagliato di un elemento specifico, utilizza i parametri di query filter e name. Per un proxy API denominato myproxy nell'organizzazione acme, chiama l'API di stato come segue:

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

Per un ambiente denominato myenv nell'organizzazione acme, chiama l'API di stato come segue:

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

La chiamata all'API sopra riportata genererà un output JSON simile al seguente per un proxy caricato di recente:

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

Stato dettagliato con informazioni sulla revisione

È possibile ottenere informazioni sulla singola revisione del proxy per un determinato proxy fornendo un parametro di query aggiuntivo showRevisions=true. L'output generato qui fornirà dettagli su ogni revisione caricata per un determinato proxy.

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

La chiamata all'API sopra riportata con il parametro showrevisions genererà un output JSON simile al seguente:

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

Stato di caricamento del gruppo

Puoi ottenere gli stati di caricamento per un gruppo di elementi utilizzando i filtri di gruppo con il parametro di query state.

Per lo stato di tutti i proxy API in stato non riuscito nell'organizzazione acme, chiama l'API di stato come segue:

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

Allo stesso modo, per ottenere un elenco dettagliato di tutti gli ambienti in attesa di un caricamento nell'organizzazione acme, chiama l'API di stato come segue:

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

Il risultato della chiamata a questa API sarà una raccolta JSON di singoli elementi di stato che corrispondono al filtro. Esempio:

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

Parametri di query per lo stato dettagliato

L'API fornisce tre parametri di query. I valori fanno distinzione tra maiuscole e minuscole.

Parametro di query Valori possibili Descrizione
filter proxy, environment Questo parametro di query indica che i risultati devono essere filtrati in base a un proxy o a un ambiente.
state failed, pending, all Questo parametro di query indica che i risultati devono essere filtrati in base allo stato oltre al filter.
name Il nome dell'elemento specifico Questo parametro di query indica che i risultati devono essere filtrati in base al nome oltre al filter.
showrevisions true, false Questo parametro di query, se fornito, genererà lo stato della revisione nell'output (valido solo quando filter=proxy).

Combinazioni di parametri per lo stato dettagliato

La tabella seguente spiega le possibili combinazioni di parametri che possono essere passate all'API REST per ottenere lo stato dettagliato. NA indica che il parametro verrà ignorato. NULL indica che il parametro non è fornito.

filter state name Risultati
proxy all NULL Segnala i dettagli sullo stato di tutti i proxy.
proxy failed NULL Segnala i dettagli sullo stato di tutti i proxy per cui il caricamento non è riuscito.
proxy pending NULL Segnala i dettagli sullo stato di tutti i proxy in attesa di caricamento o ricaricamento.
proxy NULL myproxy Segnala i dettagli sullo stato di un proxy denominato myproxy.
proxy NON-NULL NON-NULL Segnala un errore.
environment all NULL Segnala i dettagli sullo stato di tutti gli ambienti.
environment failed NULL Segnala i dettagli sullo stato di tutti gli ambienti per cui il caricamento non è riuscito.
environment pending NULL Segnala i dettagli sullo stato di tutti gli ambienti in attesa di caricamento o ricaricamento.
environment NULL myenv Segnala i dettagli sullo stato di un ambiente denominato myenv.
environment NON-NULL NON-NULL Segnala un errore.