Controlla lo stato di deployment del proxy API utilizzando l'API

Questa sezione descrive come controllare lo stato di 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'amministratore dell'organizzazione Apigee. L'account di servizio e la 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 alla chiave dell'account di servizio che hai scaricato con il ruolo Amministratore organizzazione Apigee.

  4. Chiama l'API Revisioni, con le parti seguenti:
    • 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 delle revisioni 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:

    {
      "environment": "test",
      "apiProxy": "myproxy",
      "revision": "1",
      "deployStartTime": "1616787712821",
      "state": "READY",
      "instances": [
        {
          "instance": "hybrid-docs-id",
          "deployedRevisions": [
            {
              "revision": "2",
              "percentage": 100
            }
          ],
          "deployedRoutes": [
            {
              "basepath": "/myproxy",
              "envgroup": "test-group",
              "environment": "test",
              "percentage": 100
            }
          ]
        }
      ]
    }

    Questa risposta di esempio mostra lo stato del proxy API è READY, a indicare un deployment riuscito.

    Se ricevi una risposta vuota o un errore, verifica quanto segue:

    • Hai utilizzato l'URL di base corretto. Tieni presente che l'URL di base ibrido non è uguale all'URL di base dell'API Edge. Usa 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 che non esiste, la richiesta genera una risposta vuota come la seguente:
      { }
    • Hai le autorizzazioni per accedere all'organizzazione specificata nella richiesta.
    • Il token non è scaduto. In caso affermativo, rigenerane uno nuovo come descritto in Ottenere un token di accesso OAuth 2.0.
    • Hai racchiuso l'intestazione "Authorization: Bearer $TOKEN" tra virgolette.