Como posso me conectar ao API Gateway a partir da minha rede on-premises?

Data da última atualização: 31/08/2022

Quero me conectar ao Amazon API Gateway a partir da minha rede on-premises. Como faço isso?

Breve descrição

Os tipos de API do API Gateway incluem APIs REST (endpoints de API regionais e otimizados para borda), APIs HTTP, APIs de WebSocket e APIs REST privadas. APIs REST, APIs HTTP e APIs de WebSocket podem ser conectadas diretamente a partir de redes on-premises. APIs REST privadas apenas podem ser acessadas de dentro de uma Amazon Virtual Private Cloud (Amazon VPC) usando um endpoint de VPC de interface.

Resolução

Antes de começar, verifique se a sua rede on-premises:

  • tem conectividade com a Internet.
  • tem um firewall que permite tráfego bidirecional de/para o endpoint do API Gateway.

Conectar uma rede on-premises a uma API REST, API HTTP ou API de WebSocket

Use “invoke” para conectar sua rede on-premises ao API Gateway, dependendo do tipo de API.

Para APIs REST, consulte Invocar uma API REST no Amazon API Gateway.

Para APIs HTTP, consulte Publicar APIs HTTP para invocação pelos clientes.

Para APIs de WebSocket, consulte Usar wscat para se conectar a uma API de WebSocket e enviar mensagens para ela.

Conectar uma rede on-premises a uma API REST privada

APIs REST privadas podem ser acessadas de dentro de uma Amazon VPC usando um endpoint de VPC de interface. Use os seguintes métodos de acesso, dependendo da sua configuração.

Observação:

AWS Direct Connect

Você pode usar o Direct Connect para conectar sua rede on-premises à Amazon VPC e acessar sua API privada usando nomes de DNS públicos. Para obter mais informações, consulte Acessar sua API privada usando o Direct Connect.

Alias do Amazon Route 53

Siga as etapas para associar um endpoint da Amazon VPC a uma API REST privada.

Em seguida, o API Gateway gera um novo registro de DNS ALIAS do Route 53. Você pode usar esse registro para invocar sua API privada no seguinte formato de URL:

https://{rest-api-id}-{vpce-id}.execute-api.{region}.amazonaws.com/{stage}

Para obter mais informações, consulte Acessar sua API privada usando um alias do Route 53.

Nomes de DNS privados

Se você estiver usando DNS privado, poderá acessar sua API privada a partir da sua rede on-premises usando nomes de DNS privados. Você deve configurar um endpoint de entrada do Route 53 Resolver e, em seguida, encaminhar para ele todas as consultas de DNS do DNS privado provenientes da sua rede on-premises. Para obter mais informações, consulte Invocar sua API privada usando nomes de DNS privados.

Nomes de DNS públicos

Você pode acessar sua API privada a partir da sua rede on-premises usando nomes de host de DNS específicos do endpoint. Os nomes de host de DNS públicos contêm o ID do endpoint da VPC ou o ID da API para sua API privada no seguinte formato de URL:

https://{public-dns-hostname}.execute-api.{region}.vpce.amazonaws.com/{stage}