Vérifier l'état de déploiement de votre proxy d'API à l'aide de l'API

Cette section explique comment vérifier l'état de déploiement d'un proxy d'API à l'aide des API Apigee.

  1. Déployez un proxy d'API de test, comme expliqué dans la section Créer et déployer un proxy d'API.
  2. Recherchez le fichier JSON contenant la clé du compte de service administrateur de l'organisation Apigee. Ce compte de service et cette clé ont été créés dans la section Activer l'accès du synchronisateur.
  3. Exécutez ces deux commandes pour obtenir un jeton :
    export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
    export TOKEN=$(gcloud auth application-default print-access-token)

    org-admin-service-account-file correspond au chemin d'accès de votre système vers la clé de compte de service que vous avez téléchargée avec le rôle Administrateur d'organisation Apigee.

  4. Appelez l'API Revisions avec les éléments suivants :
    • URL de base : https://apigee.googleapis.com/v1
    • URL du point de terminaison : /organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
    • Protocole : HTTPS
    • Méthode : GET
    • En-têtes : "Authorization: Bearer $TOKEN"

    L'exemple suivant appelle l'API Deployment Revisions avec ces paramètres à l'aide de curl :

    curl "https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments" \
    -X GET -H "Authorization: Bearer $TOKEN"

    Vous devriez obtenir un résultat semblable à celui-ci :

    {
      "deployments": [
        {
          "environment": "test",
          "apiProxy": "myproxy",
          "revision": "1",
          "deployStartTime": "1560782439002",
          "pods": [
            {
              "podName": "apigee-runtime-my-organization-test-blue-56b642fv429v",
              "appVersion": "self",
              "deploymentStatusTime": "1560787671389",
              "deploymentStatus": "deployed",
              "statusCode": "200",
              "statusCodeDetails": "Deployment Success",
              "deploymentTime": "1560782471370",
              "podStatus": "active",
              "podStatusTime": "1560787671389"
            },
            {
              "podName": "apigee-runtime-my-organization-test-blue-564422f7dmwj",
              "appVersion": "self",
              "deploymentStatusTime": "1560787670121",
              "deploymentStatus": "deployed",
              "statusCode": "200",
              "statusCodeDetails": "Deployment Success",
              "deploymentTime": "1560782485204",
              "podStatus": "active",
              "podStatusTime": "1560787670121"
            }
          ],
          "basePath": "/"
        }
      ]
    }

    Cet exemple de réponse montre l'état du proxy d'API sur deux pods. L'état du déploiement est deployed sur les deux pods.

    La réponse peut indiquer l'état de déploiement de votre proxy d'API sur moins ou plus de pods, en fonction de la configuration de votre cluster.

    Si vous obtenez une réponse vide ou une erreur, vérifiez les points suivants :

    • Vous avez utilisé l'URL de base correcte. Notez que l'URL de base hybride est différente de l'URL de base de l'API Edge. Utilisez https://apigee.googleapis.com/v1.
    • Vous avez utilisé l'URL de point de terminaison correcte. Notez que la révision est "1" et que le point de terminaison est /organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments. Si vous spécifiez une révision qui n'existe pas, la requête génère une réponse vide comme celle-ci :
      { }
    • Vous disposez des autorisations nécessaires pour accéder à l'organisation que vous spécifiez dans la requête.
    • Votre jeton n'a pas expiré. Le cas échéant, générez-en un nouveau comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0.
    • Vous avez placé l'en-tête "Authorization: Bearer $TOKEN" entre guillemets.