Gateway de API na Gestão de API do Azure

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo descreve os papéis e funcionalidades do componente do gateway de Gestão de APIs. Também compara os gateways que podes implementar.

Informações relacionadas:

• Para obter uma visão geral dos cenários, componentes e conceitos do Gerenciamento de API, consulte O que é o Gerenciamento de API do Azure?

• Para obter mais informações sobre as camadas de serviço e os recursos do Gerenciamento de API, consulte:

  • Camadas de gerenciamento de API
  • Comparação baseada em recursos das camadas de Gerenciamento de API do Azure.

Papel do portal

O gateway de Gerenciamento de API (também chamado de plano de dados ou tempo de execução) é o componente de serviço responsável por encaminhar solicitações de API, aplicar políticas e coletar telemetria.

Especificamente, a gateway:

• Atua como uma fachada para serviços de back-end, aceitando chamadas de API e roteando-as para back-ends apropriados
• Verifica chaves de API e outras credenciais, como JWTs e certificados apresentados com solicitações
• Impõe cotas de uso e limites de taxa
• Opcionalmente, transforma solicitações e respostas conforme especificado em declarações de política
• Se configurado, armazena em cache as respostas para melhorar a latência de resposta e minimizar a carga nos serviços de back-end
• Emite logs, métricas e rastreamentos para monitoramento, emissão de relatórios e solução de problemas

Gateways geridos e auto-hospedados

O Gerenciamento de API oferece gateways gerenciados e auto-hospedados:

• Gerido - O gateway gerido é o componente de gateway padrão que o Azure implementa para cada instância de Gestão de APIs em cada nível de serviço. Também pode associar um gateway gerido autónomo a um espaço de trabalho numa instância de Gestão de API em determinados níveis de serviço. Ao utilizar o gateway gerido, todo o tráfego da API flui através do Azure, independentemente de onde os backends que implementam as APIs estejam alojados.

  Note

  Devido às diferenças na arquitetura de serviço subjacente, os gateways fornecidos nas diferentes camadas de serviço de Gerenciamento de API têm algumas diferenças em recursos. Para mais detalhes, consulte a seção Comparação de recursos: gateways geridos versus auto-hospedados.

• Autogerido - O gateway autogerido é uma versão opcional baseada em contentores do gateway gerido por padrão, disponível em certas categorias de serviço. É útil para cenários híbridos e multicloud em que há um requisito para executar os gateways fora do Azure nos mesmos ambientes onde os back-ends de API estão hospedados. O gateway auto-hospedado permite que os clientes com infraestrutura de TI híbrida gerenciem APIs hospedadas no local e em nuvens a partir de um único serviço de Gerenciamento de API no Azure.

  • O gateway auto-hospedado é empacotado como um contentor do Docker baseado em Linux e geralmente é implantado no Kubernetes, incluindo no Serviço Kubernetes do Azure e no Kubernetes habilitado para Azure Arc.

  • Cada gateway auto-hospedado é associado a um recurso de Gateway em uma instância de Gerenciamento de API baseada em nuvem da qual recebe atualizações de configuração e comunica status.

Comparação de recursos: gateways geridos versus autogeridos

As tabelas a seguir comparam os recursos disponíveis nos seguintes gateways de Gerenciamento de API:

• Clássico - o gateway gerido disponível nas camadas de serviço Developer, Básico, Standard e Premium (anteriormente agrupadas como camadas dedicadas)
• V2 - o gateway gerenciado disponível nas camadas Basic v2, Standard v2 e Premium v2
• Consumo - o gateway gerenciado disponível na camada Consumo
• Hospedagem própria - o gateway de hospedagem própria opcional disponível nas camadas de serviço selecionadas
• Espaço de trabalho - o gateway gerenciado disponível em um espaço de trabalho em camadas de serviço selecionadas

Infraestrutura

1 Depende de como o gateway é implantado, mas é responsabilidade do cliente.
A conectividade com o endpoint de configuração do gateway auto-hospedado v2 requer a resolução DNS do nome do host do ponto de extremidade.
³ certificados raiz da CA para gateways auto-hospedados são geridos separadamente por cada gateway.
4 O protocolo do cliente precisa ser habilitado.
⁵ Configure usando a política de encaminhamento de pedidos.
⁶ Configurar os detalhes do certificado da Autoridade Certificadora para autenticação de certificados no backend nas definições de backend.

APIs de back-end

Policies

Os gateways gerenciados e auto-hospedados oferecem suporte a todas as políticas disponíveis em definições de política, com as seguintes exceções. Consulte a referência da política para obter detalhes sobre cada política.

¹ As políticas configuradas que não são suportadas pelo gateway auto-hospedado são ignoradas durante a execução da política.
² As políticas de limite de taxa por chave, cota por chave e limite de token de IA não estão disponíveis na camada de Consumo.
³ As contagens de limite de taxa em um gateway auto-hospedado podem ser configuradas para sincronizar localmente (entre instâncias de gateway nos nós de cluster), por exemplo, por meio da implantação de chart Helm para Kubernetes ou usando os modelos de implantação no portal do Azure. No entanto, as contagens de limite de taxa não são sincronizadas com outros recursos de gateway configurados na instância de Gerenciamento de API, incluindo o gateway gerenciado na nuvem. Mais informações

Monitoring

Para obter detalhes sobre as opções de monitoramento, consulte Observabilidade no Gerenciamento de API do Azure.

1 As camadas v2 suportam análises baseadas no Azure Monitor.
² Gateway utiliza o buffer de memória incorporado do Azure Application Insights e não oferece garantias de entrega.
³ Atualmente, o gateway auto-hospedado não envia logs de recursos (logs de diagnóstico) para o Azure Monitor. Opcionalmente envie métricas para o Azure Monitor ou configure e persista logs localmente onde o gateway auto-hospedado está implantado.

Autenticação e autorização

Os gateways gerenciados e auto-hospedados suportam todas as opções de autenticação e autorização de API disponíveis, com as seguintes exceções.

Capacidade de processamento e escalabilidade do gateway

Gateway gerenciado

Para obter a taxa de transferência máxima estimada do gateway nas camadas de serviço do Gerenciamento de API, consulte Preços do Gerenciamento de API.

• Níveis clássicos

  • Aumente a capacidade do gateway adicionando e removendo unidades de escala, ou atualizando a camada de serviço. (O escalonamento não está disponível no nível Developer.)
  • Nas camadas Basic, Standard e Premium, configure opcionalmente o dimensionamento automático do Azure Monitor.
  • Na camada Premium, opcionalmente, adicione e distribua a capacidade do gateway em várias regiões.

• Níveis V2

  • Aumente a capacidade do gateway adicionando e removendo unidades de escala, ou atualizando a camada de serviço.
  • Configure opcionalmente Azure Monitor autoscale.

• Nível de consumo

  • As instâncias da Gestão de API no escalão do Consumo dimensionam-se automaticamente com base no tráfego.

Gateway autónomo

• Em ambientes como o Kubernetes, adicione várias réplicas de gateway para lidar com o uso esperado.
• Opcionalmente, configure o dimensionamento automático para atender às demandas de tráfego.

Portal de espaço de trabalho

Dimensione a capacidade adicionando e removendo unidades de escala no gateway do espaço de trabalho.

Endpoint de verificação de integridade do gateway

Em todos os níveis, exceto o nível de Consumo, a Azure API Management fornece um endpoint de verificação de saúde do gateway integrado no caminho /status-0123456789abcdef. Aceda a este endpoint para ajudar a confirmar que o gateway da API está disponível e a funcionar corretamente. Não testa APIs de backend, apenas o próprio gateway.

Um pedido ao endpoint retorna uma 200 OK resposta HTTP quando o gateway está em boas condições; falhas indicam problemas de rede ou do gateway.

• O Azure utiliza este endpoint internamente para monitorização contínua de SLA e validação da saúde do gateway.
• Os clientes podem integrar pedidos para este endpoint nas suas próprias ferramentas e sondas de monitorização.
• O endpoint está disponível para gateways geridos (incluindo gateways regionais em implementações multi-regionais), gateways autogeridos e gateways de workspace.

Conteúdo relacionado

Saiba mais sobre:

• Gerenciamento de API em um mundo híbrido e multicloud
• Métrica de capacidade para decisões de dimensionamento
• Recursos de observabilidade na gestão de API
• Recursos de gateway de IA na gestão de API