Verificar o status de implantação do proxy de API usando a API

Esta seção descreve como verificar o status da implantação de um proxy de API usando as APIs da Apigee.

  1. Implante um proxy de API de teste, conforme explicado em Criar e implantar um novo proxy de API.
  2. Localize o arquivo JSON com a chave da conta de serviço da organização da Apigee. Essa conta e chave de serviço foram criadas em Ativar acesso do sincronizador.
  3. Execute estes dois comandos para receber um token:
    export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
    export TOKEN=$(gcloud auth application-default print-access-token)

    Em que org-admin-service-account-file é o caminho no seu sistema para a chave da conta de serviço que você salvou com o papel Administrador da organização da Apigee.

  4. Chame a API de revisões com as seguintes partes:
    • URL de base: https://apigee.googleapis.com/v1
    • URL do endpoint: /organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
    • Protocolo: HTTPS
    • Método: GET
    • Cabeçalhos: "Authorization: Bearer $TOKEN"

    O exemplo a seguir chama a API de revisões de implantação com essas configurações usando curl:

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

    Você receberá uma resposta semelhante a esta:

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

    Esta resposta de exemplo mostra o status do proxy da API é READY, indicando uma implantação bem-sucedida.

    Se você receber uma resposta vazia ou um erro, faça as seguintes verificações:

    • Confira se você usou o URL base correto. O URL de base híbrido é diferente do URL de base da API Edge. Use https://apigee.googleapis.com/v1.
    • Verifique se você usou o URL do endpoint correto. Observe que a revisão é "1" e o endpoint é /organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments. Se você especificar uma revisão que não existe, a solicitação resultará em uma resposta vazia como esta:
      { }
    • Certifique-se de que tem permissões para acessar a organização especificada na solicitação.
    • Verifique se seu token não expirou. Se tiver expirado, gere um novo, conforme descrito em Receber um token de acesso do OAuth 2.0.
    • Veja se adicionou o cabeçalho "Authorization: Bearer $TOKEN" entre aspas.