Vérifier l'état et les paramètres de l'intégration

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Cette page explique comment vérifier l'état et les paramètres de l'intégration du connecteur de hub d'API Apigee Edge dans votre organisation Apigee Edge une fois qu'il est activé.

Vérifier les paramètres d'intégration du connecteur du hub d'API

Pour récupérer les paramètres d'intégration du connecteur API Hub pour une organisation, envoyez une requête GET :

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

Où :

  • ORG_NAME est le nom de votre organisation Apigee Edge.
  • OAUTH_TOKENest le jeton OAuth utilisé pour authentifier la requête. Pour en savoir plus sur la création d'un jeton OAuth, consultez Obtenir les jetons.

Une réponse réussie ressemble à ceci :

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

"enabled": true confirme que l'intégration du connecteur API Hub est activée pour l'organisation.

"gatewayId" affiche le nom de ressource de l'instance à laquelle cette organisation Apigee Edge est connectée.

Vérifier l'état consolidé

Pour obtenir un état consolidé incluant la progression détaillée de l'importation, envoyez une requête GET à l'API Edge Management :

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

Où :

  • ORG_NAME est le nom de votre organisation Apigee Edge.

Une réponse consolidée réussie ressemblera à ce qui suit, en indiquant la progression de l'importation pour les proxys et les environnements. L'exemple ci-dessous montre une phase 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
      }
    }
  }
}

Champs d'état consolidés

Champ Description
phase Phase de traitement actuelle pour l'organisation. Les valeurs possibles du champ sont les suivantes :
  • Queued : l'organisation a été ajoutée récemment et est en file d'attente pour le traitement initial.
  • Preparing : l'organisation est en état de transfert à froid, où tous les proxys existants sont importés dans API Hub. Cet état s'affiche lorsque l'organisation a été ajoutée récemment et est en cours de préparation.
  • Processing : l'organisation est dans un état de mise à jour continue, où les modifications apportées aux proxys et aux environnements sont constamment importées dans API Hub.
lastUpdated Code temporel du dernier événement traité pour cette organisation.
components Carte fournissant des informations détaillées sur les proxys et les environnements qui ont été traités. La carte peut contenir les clés suivantes :
  • proxy : fournit des statistiques détaillées sur les proxys d'API du système Edge qui ont été traités et importés dans API Hub.
  • environment : fournit des décomptes détaillés des environnements du système Edge qui ont été traités et importés dans le hub d'API.
progress Les valeurs des sections proxy ou environment sont les suivantes :
  • totalItems : nombre total d'articles.
  • pendingItems : nombre d'éléments en attente de traitement.
  • completedItems : nombre d'éléments traités avec succès.
  • failedItems : nombre d'éléments dont l'importation a échoué.

Vérifier l'état détaillé de l'importation

Vous pouvez vérifier l'état détaillé d'un proxy d'API ou d'un environnement individuel, ou d'un groupe d'éléments filtrés par état, à l'aide du point de terminaison /details et des paramètres de requête.

État d'un élément spécifique

Pour vérifier l'état détaillé d'un élément spécifique, utilisez les paramètres de requête filter et name. Pour un proxy d'API nommé myproxy dans l'organisation acme, appelez l'API d'état comme suit :

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

Pour un environnement nommé myenv dans l'organisation acme, appelez l'API d'état comme suit :

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

L'appel de l'API ci-dessus générera une sortie JSON semblable à celle-ci pour un proxy qui a été importé récemment :

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

État détaillé avec des informations sur la révision

Il est possible d'obtenir des informations sur la révision de proxy individuelle pour un proxy donné en fournissant un paramètre de requête supplémentaire showRevisions=true. Le résultat généré ici fournit des informations sur chaque révision qui a été importée pour un proxy donné.

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

L'appel de l'API ci-dessus avec le paramètre showrevisions générera une sortie JSON semblable à ce qui suit :

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

État de l'importation de groupe

Vous pouvez obtenir l'état d'importation d'un groupe d'articles en utilisant des filtres de groupe avec le paramètre de requête state.

Pour connaître l'état de tous les proxys d'API qui sont dans l'état failed (Échec) dans l'organisation acme, appelez l'API d'état comme suit :

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

De même, pour obtenir la liste détaillée de tous les environnements pour lesquels une importation est en attente dans l'organisation acme, appelez l'API d'état comme suit :

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

L'appel de cette API renverra une collection JSON d'éléments d'état individuels correspondant au filtre. Exemple :

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

Paramètres de requête pour l'état détaillé

L'API fournit trois paramètres de requête. Les valeurs sont sensibles à la casse.

Paramètre de requête Valeurs possibles Description
filter proxy, environment Ce paramètre de requête indique que les résultats doivent être filtrés par un proxy ou un environnement.
state failed, pending, all Ce paramètre de requête indique que les résultats doivent être filtrés par état en plus de filter.
name Nom de l'article spécifique Ce paramètre de requête indique que les résultats doivent être filtrés par nom en plus de filter.
showrevisions true, false Ce paramètre de requête, lorsqu'il est fourni, génère l'état de révision dans la sortie (valide uniquement lorsque filter=proxy).

Combinaisons de paramètres pour l'état détaillé

Le tableau ci-dessous explique les combinaisons de paramètres possibles qui peuvent être transmises à l'API REST afin d'obtenir un état détaillé. NA indique que le paramètre sera ignoré. NULL indique que le paramètre n'est pas fourni.

filtre state nom Résultats
proxy all NULL Affiche les détails de l'état de tous les proxys.
proxy failed NULL Détails de l'état des rapports pour tous les proxys dont l'importation a échoué.
proxy pending NULL Affiche des informations sur l'état de tous les proxys dont l'importation ou la réimportation est en attente.
proxy NULL myproxy Affiche les détails de l'état d'un proxy nommé myproxy.
proxy NON-NULL NON-NULL Signale une erreur.
environment all NULL Détails de l'état des rapports pour tous les environnements.
environment failed NULL Affiche les détails de l'état de tous les environnements dont l'importation a échoué.
environment pending NULL Affiche les détails de l'état de tous les environnements dont l'importation ou la réimportation est en attente.
environment NULL myenv Affiche les détails de l'état d'un rapport pour un environnement nommé myenv.
environment NON-NULL NON-NULL Signale une erreur.