Controllare lo stato del deployment del proxy API utilizzando l'API

Questa sezione descrive come verificare lo stato del deployment di un proxy API utilizzando le API Apigee.

  1. Esegui il deployment di un proxy API di test come spiegato in Creare ed eseguire il deployment di un nuovo proxy API.
  2. Individua il file JSON con la chiave dell'account di servizio dell'organizzazione Apigee. Questo account di servizio e questa chiave sono stati creati in Abilita l'accesso del sincronizzatore.
  3. Esegui questi due comandi per ottenere un token:
    export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
    export TOKEN=$(gcloud auth application-default print-access-token)

    Dove org-admin-service-account-file è il percorso del tuo sistema verso la chiave dell'account di servizio che hai scaricato con il ruolo di amministratore dell'organizzazione Apigee.

  4. Chiama l'API Revisions, con le seguenti parti:
    • URL di base: https://apigee.googleapis.com/v1
    • URL endpoint: /organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
    • Protocollo:HTTPS
    • Metodo: GET
    • Intestazioni: "Authorization: Bearer $TOKEN"

    L'esempio seguente chiama l'API Revisions del deployment con queste impostazioni utilizzando curl:

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

    Dovresti ricevere una risposta simile alla seguente:

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

    Questa risposta di esempio mostra lo stato del proxy API su due pod. Lo stato del deployment è deployed su entrambi i pod.

    La tua risposta potrebbe mostrare lo stato del deployment del proxy API su un numero inferiore o superiore di pod, a seconda della configurazione del cluster.

    Se viene visualizzata una risposta vuota o un errore, verifica che:

    • Hai utilizzato l'URL di base corretto. Tieni presente che l'URL di base ibrido non corrisponde a quello dell'API Edge. Usa la lingua https://apigee.googleapis.com/v1.
    • Hai utilizzato l'URL dell'endpoint corretto. Tieni presente che la revisione è"1"e l'endpoint è /organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments. Se specifichi una revisione inesistente, la richiesta restituisce una risposta vuota come la seguente:
      { }
    • Disponi delle autorizzazioni per accedere all'organizzazione specificata nella richiesta.
    • Il tuo token non è scaduto. In caso affermativo, rigenerane uno nuovo come descritto in Ottenere un token di accesso OAuth 2.0.
    • Hai aggregato l'intestazione "Authorization: Bearer $TOKEN" tra virgolette.