Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2023-03-08 GMT+08:00

Conceitos básicos

API

Um conjunto de funções predefinidas que encapsula as capacidades da aplicação. Você pode criar APIs e torná-las acessíveis aos usuários.

Ao criar uma API, você precisa configurar as informações básicas e os caminhos de solicitação, parâmetros e protocolos de front-end e back-end.

Grupo de API

Uma coleção de APIs usadas para o mesmo serviço. Os grupos de API facilitam o gerenciamento da API.

Ambiente

Um estágio no ciclo de vida de uma API. Um ambiente, como teste de API ou ambiente de desenvolvimento, especifica o escopo de uso das APIs, facilitando o gerenciamento do ciclo de vida da API. A mesma API pode ser publicada em diferentes ambientes.

Para chamar uma API em diferentes ambientes, você precisa adicionar o parâmetro de cabeçalho x-stage à solicitação enviada para chamar a API. O valor deste parâmetro é um nome de ambiente.

Variável de ambiente

Uma variável que é gerenciável e específica para um ambiente. Você pode criar variáveis em ambientes diferentes para chamar diferentes serviços de back-end usando a mesma API.

Limitação de solicitação

Controla o número de vezes que as APIs podem ser chamadas por um usuário, uma credencial ou um endereço IP durante um período específico para proteger os serviços de back-end.

A limitação de solicitação pode ser precisa ao minuto e ao segundo.

Controle de acesso

As políticas de controle de acesso são uma das medidas de segurança fornecidas pelo API Gateway. Eles permitem ou negam acesso à API de endereços IP ou contas específicas.

Credencial

Uma entidade que solicita APIs. Uma credencial pode ser autorizada a acessar várias APIs e várias credenciais podem ser autorizadas a acessar a mesma API.

Chave de assinatura

Consiste em uma chave e um segredo, que são usados pelos serviços de back-end para verificar a identidade do API Gateway e garantir o acesso seguro.

Quando uma API vinculada a uma chave de assinatura é chamada, o API Gateway adiciona informações de assinatura às solicitações da API. O serviço de back-end da API assina as solicitações da mesma maneira e verifica a identidade do API Gateway, verificando se a assinatura é consistente com a do cabeçalho Authorization enviado pelo API Gateway.

Canal de balanceamento de carga

Um método usado para acessar serviços implementados em VPCs. Você pode expor seletivamente serviços de back-end implementados em VPCs a usuários de terceiros.

Autenticação personalizada

Um mecanismo definido com regras personalizadas para o API Gateway verificar a validade e a integridade das solicitações iniciadas pelos chamadores da API. O mecanismo também é usado para serviços de back-end para verificar as solicitações encaminhadas pelo API Gateway.

Os dois tipos de autenticação personalizada a seguir são fornecidos:

  • Autenticação personalizada do front-end: um autorizador personalizado é configurado com uma função para autenticar solicitações de uma API.
  • Autenticação personalizada de back-end: um autorizador personalizado pode ser configurado para autenticar solicitações para diferentes serviços de back-end, eliminando a necessidade de personalizar APIs para diferentes sistemas de autenticação e simplificando o desenvolvimento de APIs. Você só precisa criar um autorizador personalizado baseado em função no API Gateway para se conectar ao sistema de autenticação de back-end.

Autenticação simples

A autenticação simples facilita a resposta rápida para solicitações de API adicionando o parâmetro X-Apig-AppCode (cujo valor é um AppCode) ao cabeçalho da solicitação HTTP. O API Gateway verifica apenas o AppCode e não verifica a assinatura da solicitação.

Resposta do gateway

As respostas do gateway são retornadas se o API Gateway falhar ao processar solicitações de API. O API Gateway fornece respostas padrão para vários cenários e permite personalizar códigos de status e conteúdo de resposta. Você pode adicionar uma resposta de gateway no formato JSON na página API Groups.