Controllare 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 e implementare un nuovo proxy API.
  2. Individua il file JSON con la chiave dell'account di servizio dell'amministratore dell'organizzazione Apigee. Questo account di servizio e questa chiave sono stati creati in Abilitare 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 sul sistema della chiave dell'account di servizio che hai scaricato con il ruolo Amministratore dell'organizzazione Apigee.

  4. Chiama l'API revisioni 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"

    Il seguente esempio chiama l'API delle revisioni di 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 che lo stato del proxy API è READY, indicando un deployment riuscito.

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

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