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

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

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

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 du hub d'API d'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_TOKEN est 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 se présente comme suit :

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

"enabled": true confirme que l'intégration du connecteur du hub d'API 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 de gestion Edge :

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 se présente comme suit, affichant 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é

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ère 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 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. La sortie générée ici fournit des détails 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ère une sortie JSON semblable à celle-ci :

{
  "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 groupée

Vous pouvez obtenir les états d'importation pour un groupe d'éléments 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 un é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 une liste détaillée de tous les environnements dont l'importation est pending (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 génère une collection JSON d'éléments d'état individuels qui correspondent 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.

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.