API Gateway:Acesse um service de back-end em VPC com o API Gateway

Pré-requisitos

• Você possui uma VPC. Para mais informações, consulte Create a VPC with an IPv4 CIDR block e Create a VPC with an IPv6 CIDR block.

• Você possui uma instância ECS. Para mais informações, consulte Create an ECS instance.

Procedimento

Para usar o API Gateway no acesso a um service de back-end em uma VPC, siga estas etapas:

• Create a VPC access authorization

• Create an API group

• Create an API

• Create an application and authorize it to call the API

• Allow the egress IP address of API Gateway in a security group

• Debug the API

• Call the API

Crie uma autorização de acesso à VPC

Crie uma autorização de acesso à VPC para permitir que o API Gateway acesse sua VPC.

1. Faça login no console do API Gateway. Selecione uma região e, no painel de navegação à esquerda, escolha API Management > VPC Authorization.

2. Na página Authorization List, clique em Create Authorization no canto superior direito.

3. Na página Create VPC Authorization, insira o VPC Authorization Name, o VPC Id, o Instance ID or IP Address e a Port.

   Nota

   • Para acessar um site (vhost) em uma instância SLB ou ECS usando um nome de domínio específico, configure o nome de domínio no campo Host.

   • Encontre o ID da VPC, o ID da instância ou o endereço IP privado na página de detalhes do seu service de back-end, como uma instância ECS ou Classic Load Balancer (CLB).

Crie um grupo de APIs

Crie uma API

1. Faça login no console do API Gateway. Selecione uma região e, no painel de navegação à esquerda, escolha API Management > Group Management.

2. Na página Group List, localize o grupo nginx-demo e clique em API Management na coluna Actions.

3. Na página API List, clique em Create API no canto superior direito.

4. Na página Create API, na seção Basic Information, configure os seguintes parâmetros e clique em Next.

   Parâmetro	Exemplo
   Group	nginx-demo
   API Name	nginx-test
   Security Authentication	Alibaba Cloud App
   AppCode Authentication	Allow AppCode (Header & Query) Authentication
   Signature Algorithm	HMAC_SHA256

5. Na seção Define API Request, configure os seguintes parâmetros e clique em Next.

   Parâmetro	Exemplo
   Protocol	HTTP, HTTPS
   Request Path	/nginx
   HTTP Method	GET
   Request Mode	Pass-through

   Nota

   Esta etapa define como um cliente, como um navegador, aplicativo móvel ou outro sistema empresarial, envia requisições para sua API. Defina o protocolo de requisição, o caminho da requisição, o método http e o modo de requisição. Neste exemplo, o Request Mode está definido como Pass-through, o que significa que o API Gateway encaminha as requisições do cliente com seus parâmetros originais diretamente para o service de back-end na VPC.

6. Na seção Define Backend Service, configure os seguintes parâmetros e clique em Next.

   Parâmetro	Exemplo
   Backend Configuration	Selecione Custom Backend Service
   Backend Service Type	Selecione VPC
   VPC Authorization Name	***-microservice
   Backend Request Path	/
   HTTP Method	GET
   Backend Timeout	10000

   Nota

   Esta etapa define como o API Gateway mapeia parâmetros e se conecta ao service de back-end após receber uma requisição do cliente. Neste exemplo, o tipo de service de back-end é VPC. Selecione a autorização de acesso à VPC criada ou insira seu nome e especifique o caminho da requisição de back-end.

7. Na seção Define Response, clique em Create.

   Nota

   Esta etapa gera a documentação da API para ajudar os chamadores a entendê-la. Defina o Content-Type da resposta, o exemplo de resposta e o exemplo de resposta de erro. Este exemplo não envolve essas configurações. Clique em Create.

8. Na mensagem exibida, clique em Publish.

9. Na caixa de diálogo Publish API, defina Environment como Release, insira uma descrição no campo Remarks e clique em Publish.

   Nota

   Após modificar uma API, publique-a em um ambiente para que as alterações entrem em vigor. O API Gateway fornece três ambientes integrados: Release, Pre e Test.

Crie um aplicativo e autorize a API

Um aplicativo é a identidade usada para chamar uma API. Neste exemplo, o método de autenticação está definido como "Alibaba Cloud App" quando você create the API. Após publicar a API, crie um aplicativo e autorize-o a chamá-la.

Permita o IP de saída do API Gateway no grupo de segurança

Se o grupo de segurança da sua instância ECS tiver regras de entrada que restrinjam o tráfego, adicione o endereço IP de saída do API Gateway à lista de permissões do grupo de segurança. Essa ação impede que o grupo de segurança bloqueie requisições do API Gateway. O endereço IP de saída necessário pertence à instância que hospeda seu grupo de APIs.

1. Faça login no console do API Gateway. No painel de navegação à esquerda, escolha API Management > Group Management e clique no nome do grupo de APIs desejado.

2. Na página Group Details, visualize o Instance Type do grupo.

3. No painel de navegação à esquerda, escolha Instances and Clusters. Clique no tipo de instância, localize a instância correspondente e visualize as informações de Egress IP Address.

   Os endereços IP de saída incluem um endereço IP de saída público e um endereço VPC interno.

4. Faça login no console do ECS. No painel de navegação à esquerda, escolha Instances & Images > Instances. Clique no ID da sua instância ECS. Acesse a aba Security Groups e clique no nome do grupo de segurança. Na página Security Group Details, escolha Inbound > Quickly Add Rules e configure o endereço IP de saída do gateway.

   Na caixa de diálogo Quickly Add Rules, defina Authorization Policy como Allow. Insira o endereço IP de saída do gateway no campo Authorization Object. Selecione All (1/65535) em Port Range e clique em OK.

Depure a API

Após configurar uma API, use este recurso para verificar se ela funciona conforme o esperado antes de chamá-la a partir de um cliente.

1. Faça login no console do API Gateway. No painel de navegação à esquerda, escolha API Calling > Debug.

2. Na página Debug, selecione a API nginx-test criada. Em Authentication Method, selecione Use AppCode. Em seguida, clique em Send Request.

   Se a chamada for bem-sucedida, o código de status da resposta será 200 e o corpo da resposta retornará a página de boas-vindas padrão do Nginx em HTML, incluindo textos como Welcome to nginx!.

   Se a depuração falhar, consulte os seguintes tópicos:

   • FAQ overview

   • Error codes

Chame a API

Para mais informações, consulte Call an API from a client.