Como implantar um proxy de API

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Observação: para implantar proxies de API em ambientes ativados para implantações de arquivos, consulte Como implantar e gerenciar arquivos em um ambiente da Apigee.

Não é possível invocar um proxy de API antes que ele seja implantado. Depois de criar um novo proxy de API ou alterar um atual, implante-o no cluster.

Quando você cria uma nova revisão de um proxy de API sem alterar o caminho de base e, em seguida, implanta-a em um ambiente em que ela já está implantada, a versão anterior é removida e a nova revisão é implantada.

Observação: não é possível fazer alterações incrementais em uma revisão de proxy de API e reimplantar essa mesma revisão no Apigee. Para implantar alterações em um proxy de API, você precisa salvá-lo como uma nova revisão e implantá-lo.

Implantar um proxy de API

Implante uma revisão de proxy de API conforme descrito nas seções a seguir.

Observação: a Apigee está introduzindo uma nova versão do Editor de Proxy, que facilitará o gerenciamento de proxies.

As instruções nas duas primeiras guias abaixo explicam como usar o novo Editor de proxy ou o Proxy Editor clássico.

Novo Editor de Proxy

Para implantar um proxy de API na interface da Apigee:

1. Se você estiver usando a interface da Apigee no console do Cloud: selecione Desenvolvimento de proxy > Proxies de API.

   Se você estiver usando a interface clássica da Apigee: selecione Desenvolver > Proxies de API e no painel Proxies, selecione o ambiente do proxy.

2. Clique no proxy de API que você quer implantar. A IU exibe a página Visão geral:

   

3. Para implantar as alterações, primeiro clique em Implantar para exibir a caixa de diálogo Implantar:

   

4. Digite o seguinte:
   • Revisão: o número de revisão do proxy que você quer implantar.
   • Ambiente: o ambiente em que você quer implantar o proxy.
   • Conta de serviço (opcional): uma conta de serviço para o proxy.
5. Clique em Implantar.

A interface inicia o processo de implantação da revisão selecionada.

Observação: pode levar alguns minutos para que a Apigee implante o novo proxy.

Quando o proxy é implantado, a coluna Status na seção Implantações exibe um ícone verde para mostrar que a revisão 1 do proxy está implantada.

Editor de Proxy clássico

Para implantar um proxy de API na IU da Apigee:

1. Faça login na IU da Apigee.
2. Selecione Desenvolver > Proxies de API.

   A IU exibe uma lista de proxies de API e os status de implantação deles:

   

3. Na lista suspensa Ambiente, selecione o ambiente em que você quer implantar o proxy da API.

4. Clique no proxy de API que você quer implantar.

   A IU exibe a guia Visão geral dos proxies de API. Essa visualização inclui as seções Implantações, Endpoints de proxy e Endpoints de destino:

   

   Se este for um novo proxy de API que nunca foi implantado antes (ou um proxy de API que você tenha cancelado a implantação), a coluna Revisão exibirá o texto Não implantado.

5. Na coluna Revisão, expanda o seletor suspenso.

   Se este for um novo proxy de API que nunca foi implantado, a lista suspensa exibirá apenas 1 e Cancelar a implantação:

   

   Para proxies de API com várias revisões, a lista suspensa exibe todas as revisões disponíveis, bem como a opção Cancelar a implantação.

   

6. Selecione a revisão que você quer implantar na lista suspensa.

   A IU solicita que você confirme a implantação:

   

7. Clique em Implantar.

   A interface inicia o processo de implantação da revisão selecionada.

   Observação: pode levar alguns minutos para que a Apigee implante o novo proxy.

   Posicione o cursor sobre o link Detalhes na coluna "Status" para ver o status da implantação. Se já houver uma ou mais revisões implantadas, será possível monitorar o status da remoção da implantação, conforme mostrado na figura a seguir. Para mais informações, consulte Implantação sem inatividade.

   

   Quando a implantação é concluída, os detalhes de status indicam que a revisão foi totalmente implantada:

   

   Observe que a implantação não é um processo instantâneo. O modelo de implantação consistência posterior da Apigee significa que uma nova implantação será lançada no cluster em um curto período, e não imediatamente. Para mais informações, consulte Sobre a implantação.

   Para mais informações sobre o significado dos indicadores de status e como verificar o status, consulte Como visualizar o status da implantação.

   

Como alternativa, é possível implantar a revisão atual que você está editando na guia Desenvolver. Quando você faz isso, o Apigee cria uma nova revisão para você.

1. Clique na lista suspensa Implantar em: env_name.

   

   A IU exibe uma lista de ambientes. Na coluna Revisão, a IU lista a revisão implantada atualmente (ou "---", se não houver).

2. Clique em Implantar revision para implantar a revisão que você editou mais recentemente.

   A IU solicita que você confirme a implantação.

3. Clique em Implantar.

   A IU inicia o processo de implantação da revisão selecionada.

API Apigee

Nas seções a seguir, você verá exemplos de como usar a API Apigee para implantar revisões de proxy da API e listar as implantações em sua organização.

• Criação de relatório de alteração de implantação antes da implantação
• Como implantar uma revisão de proxy de API usando a API
• Como listar implantações de um proxy de API usando a API

Consulte também Como ver o status da implantação.

Criação de relatório de alteração de implantação antes da implantação

A implantação de um proxy em mais de um ambiente do mesmo grupo de ambientes pode resultar em um comportamento indefinido. Para determinar se isso ocorrerá, gere um relatório usando o método generateDeployChangeReport da seguinte maneira:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/deployments:generateDeployChangeReport" \
-X POST \
-H "Authorization: Bearer $TOKEN"

Isso retorna um relatório de alteração de implantação que avisa se um caminho base do proxy que você quer implantar não receberá tráfego devido a uma implantação atual que já usa esse caminho base.

Como implantar uma revisão de proxy de API usando a API

Para implantar uma revisão de proxy da API, use a seguinte chamada de API:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

Em que $TOKEN está definido como seu token de acesso OAuth 2.0, conforme descrito em Como receber um token de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte Como usar curl. Para uma descrição das variáveis de ambiente usadas, consulte Como definir variáveis de ambiente para solicitações de API da Apigee.

Ponto-chave: se uma revisão de proxy da API existente for implantada, defina o parâmetro de consulta override como true. Nesse caso, o Apigee implanta a nova revisão totalmente antes de remover a implantação atual, conforme descrito em Implantação sem inatividade.

Veja a seguir um exemplo da saída da resposta: Neste exemplo, a revisão 1 do proxy de API helloworld foi implantada com sucesso no ambiente test:

{
  "environment": "test",
  "apiProxy": "helloworld",
  "revision": "1",
  "deployStartTime": "1559149080457"
}

Para mais informações, consulte Implantar a API Proxy Revision.

Como listar implantações usando a API

Para listar todas as implantações de proxies de API e fluxos compartilhados da sua organização, digite a seguinte chamada de API:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/deployments" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Em que $TOKEN está definido como seu token de acesso OAuth 2.0, conforme descrito em Como receber um token de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte Como usar curl. Para uma descrição das variáveis de ambiente usadas, consulte Como definir variáveis de ambiente para solicitações de API da Apigee.

Importante: ao visualizar uma lista de implantações, o status da implantação não será fornecido. Para ver o status da implantação de uma revisão de proxy de API individual, consulte Como visualizar o status da implantação.

Veja a seguir um exemplo da resposta. Neste exemplo, há três proxies de API implantados, incluindo helloworld que foi implantado na seção anterior.

{
  "deployments": [
    {
      "environment": "test",
      "apiProxy": "helloworld",
      "revision": "1",
      "deployStartTime": "1559149080457"
    },
    {
      "environment": "test",
      "apiProxy": "weather",
      "revision": "1",
      "deployStartTime": "1558620435217"
    },
    {
      "environment": "test",
      "apiProxy": "testproxy",
      "revision": "2",
      "deployStartTime": "1558635113086"
    }
  ]
}

gcloud

Nas seções a seguir, você verá exemplos de como usar comandos da CLI gcloud apigee para implantar revisões de proxy de API e listar as implantações na sua organização.

• Como implantar uma revisão de proxy de API usando a CLI gcloud
• Como listar implantações de um proxy de API usando a CLI gcloud

Consulte também Como ver o status da implantação.

Para mais informações e uma descrição das variáveis de ambiente usadas nos exemplos, consulte Primeiros passos com a gcloud na Apigee.

Como implantar uma revisão de proxy de API usando a CLI gcloud

Para implantar uma revisão de proxy de API, use o seguinte comando gcloud:

gcloud apigee apis deploy $REV --api=$API --environment=$ENV

Ponto-chave: se uma revisão de proxy do API atual for implantada, defina a sinalização override como true. Nesse caso, o Apigee implanta a nova revisão totalmente antes de remover a implantação atual, conforme descrito em Implantação sem inatividade.

Veja a seguir um exemplo da saída da resposta: Neste exemplo, a revisão 1 do proxy de API helloworld foi implantada com sucesso no ambiente test:

Using Apigee organization 'my-org'
apiProxy: helloworld
deployStartTime: '1598032332802'
environment: test
revision: '1'

Para mais informações, consulte Implantar a CLI de revisão de proxy da API.

Como listar implantações usando a CLI gcloud

Para listar todas as implantações de proxies de API e fluxos compartilhados na sua organização, use o seguinte comando gcloud:

gcloud apigee deployments list

Importante: ao visualizar uma lista de implantações, o status da implantação não será fornecido. Para ver o status de implantação de um proxy de API individual, consulte Como ver o status de implantação.

Veja a seguir um exemplo da resposta. Neste exemplo, há três proxies de API implantados, incluindo helloworld que foi implantado na seção anterior.

Using Apigee organization `my-org`
 - apiProxy: helloworld
   deployStartTime: 1598032332802
   environment: test
   revision: 1
 - apiProxy: weather
   deployStartTime: 1558620435217
   environment: test
   revision: 1
 - apiProxy: testproxy
   deployStartTime: 1558635113086
   environment: test
   revision: 2

Para mais informações, consulte Listar implantações de CLI.

Solução de problemas

Se não for possível implantar o proxy de API, verifique se um dos cenários comuns a seguir pode ser aplicado.

Restrições de nomenclatura para grupos de ambientes

Se o nome do grupo de ambiente não estiver em conformidade com as restrições de nomenclatura, o proxy não será implantado. Em alguns casos, é possível criar um grupo de ambiente e adicionar ambientes a ele sem precisar atender a essas restrições. No entanto, isso impedirá a implantação do proxy.

Consulte Como criar grupos de ambientes para uma descrição das diretrizes e restrições de nomenclatura.

Ambiente criado com um nome de ambiente usado anteriormente

Se você criar um ambiente com o mesmo nome de um ambiente excluído anteriormente, o proxy não será implantado. Por exemplo, se você criou um ambiente chamado prod-1 depois de criar e excluir um ambiente prod-1 anteriormente, será necessário removê-lo. Siga estas etapas para resolver o problema:

1. Desanexe o ambiente prod-1 do seu grupo de ambientes usando a API.
2. Exclua o ambiente prod-1 usando a API.
3. Crie um novo ambiente. Por exemplo, prod-2
4. Anexe o novo ambiente prod-2 ao seu grupo de ambientes usando a API.