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 l'attivazione.

Controllo delle impostazioni di integrazione del connettore dell'hub API

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

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 ulteriori informazioni sulla creazione di un token OAuth, consulta Recuperare i token.

Una risposta corretta è simile alla seguente:

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

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

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

Controllo dello stato consolidato

Per uno stato consolidato che includa lo stato di avanzamento dettagliato del caricamento, effettua una richiesta GET all'API Edge Management:

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 l'avanzamento del caricamento per i proxy e gli 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 di stato consolidati

Controllo dello stato di caricamento dettagliato

Puoi controllare lo stato dettagliato di un singolo proxy API o ambiente oppure 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 nel seguente modo:

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 nel seguente modo:

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

La chiamata all'API precedente genera 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 revisione del singolo 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 precedente 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 del caricamento di 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 che si trovano nello stato failed nell'organizzazione acme, chiama l'API di stato nel seguente modo:

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 stato In attesa di caricamento nell'organizzazione acme, chiama l'API di stato nel seguente modo:

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 sono sensibili alle maiuscole.

Combinazioni di parametri per lo stato dettagliato

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