Configuração de parâmetros

Restrição

A modificação dos parâmetros de configuração do gateway interromperá os serviços. Faça isso fora do horário de pico ou quando nenhum serviço estiver em execução.

Procedimento

1. Vá para o console do APIG.

2. No painel de navegação, escolha Gateways.
3. Clique em Access Console ou no nome do gateway de destino.
4. Clique na guia Parameters e clique em Modify na linha que contém o parâmetro de destino. Os parâmetros de configuração variam de acordo com a edição do gateway.

   Tabela 1 Parâmetros de configuração

   Parâmetro	Descrição
   ratelimit_api_limits	Valor padrão de limitação de solicitação aplicado a todas as APIs. Padrão: 200 chamadas/segundo. O número total de vezes que uma API pode ser chamada é determinado por esse parâmetro somente se nenhuma política de limitação de solicitações estiver vinculada à API. O Max. API Requests de uma política de limitação de solicitações não pode exceder o valor desse parâmetro.
   request_body_size	Tamanho máximo do corpo permitido para uma solicitação de API. Padrão: 12 MB.
   backend_timeout	Tempo limite de resposta do back-end. Padrão: 60.000 ms. Intervalo: 1–600.000 ms.
   app_token	Determine se a autenticação app_token deve ser ativada. Padrão: desativada. Se você ativar essa função, um access_token poderá ser adicionado à solicitação de API para autenticação. app_token_expire_time: período de validade de um access_token. Um novo access_token deve ser obtido antes que o access_token original expire. refresh_token_expire_time: o período de validade de um refresh_token. Um refresh_token é usado para obter um novo access_token. app_token_uri: o URI usado para obter um access_token. app_token_key: a chave de criptografia de um token de acesso.
   app_api_key	Determine se a autenticação app_api_key deve ser ativada. Padrão: desativada. Se você ativar essa função, o parâmetro apikey pode ser adicionado à solicitação da API para carregar a chave de uma credencial para autenticação.
   app_basic	Determine se a autenticação app_basic deve ser ativada. Padrão: desativada. Depois que essa opção estiver ativada, os usuários podem adicionar o parâmetro de cabeçalho Authorization e definir o valor do parâmetro como "Basic + base64 (appkey + : + appsecret)", no qual appkey e appsecret são a chave e o segredo de uma credencial.
   app_secret	Determine se a autenticação app_secret deve ser ativada. Padrão: desativada. Se você ativar essa função, os parâmetros X-HW-ID e X-HW-AppKey poderão ser adicionados à solicitação da API para transportar a chave e o segredo de uma credencial para autenticação.
   app_route	Determine se deve ser compatível com o acesso à API baseado em endereço IP. Padrão: desativado. Se você ativar essa função, as APIs em qualquer grupo, exceto DEFAULT, podem ser chamadas usando endereços IP.
   backend_client_certificate	Determine se deve ativar a autenticação bidirecional de back-end. Padrão: desativada. Se você ativar essa função, poderá configurar a autenticação bidirecional para um back-end ao criar uma API.
   ssl_ciphers	Conjuntos de criptografia HTTPS suportados. Por padrão, todos os conjuntos de criptografia são suportados. Selecione conjuntos de criptografia depois de vincular nomes de domínio independentes a um grupo de APIs.
   real_ip_from_xff	Determine se os endereços IP devem ser usados no cabeçalho X-Forwarded-For para controle de acesso e limitação de solicitação. Por padrão, os endereços IP neste cabeçalho não são usados. xff_index: número de sequência de um endereço IP no cabeçalho X-Forwarded-For. O valor pode ser positivo, negativo ou 0. Se o valor for 0 ou positivo, o endereço IP do índice correspondente no cabeçalho X-Forwarded-For será obtido. Se o valor for negativo, o endereço IP da sequência inversa indicada no cabeçalho X-Forwarded-For será obtido. Por exemplo, suponha que o cabeçalho X-Forwarded-For de uma solicitação recebida pelo API Gateway contenha três endereços IP: IP1, IP2 e IP3. Se o valor de xff_index for 0, IP1 é obtido. Se o valor for 1, IP2 é obtido. Se o valor for -1, IP3 é obtido. Se o valor for -2, IP2 é obtido.
   vpc_name_modifiable	Determine se os nomes dos canais de balanceamento de carga podem ser modificados. Por padrão, os nomes podem ser modificados. AVISO: Se essa opção estiver ativada, os canais de balanceamento de carga do gateway atual não poderão ser gerenciados usando as APIs de gerenciamento de canais de balanceamento de carga no nível do projeto.
   app_jwt_enable	Determine se a autenticação app_jwt deve ser ativada. Padrão: desativada. Se você ativar essa função, os parâmetros Authorization e Timestamp podem ser adicionados às solicitações de API para transportar a chave, o segredo e o carimbo de data/hora de uma credencial para autenticação. app_jwt_auth_header é um cabeçalho incluído nas solicitações de API para autenticação app_jwt. O valor padrão do cabeçalho é Authorization.
   public_key_enable	Determine se deve ativar a autenticação public_key. Padrão: desativada. Se você ativar essa opção, chaves de assinatura do tipo public_key podem ser usadas para autenticação. public_key_uri_prefix indica o prefixo do URI usado para obter o segredo de public_key. O formato do URI é o seguinte: https://{VPC access address}{public_key_uri_prefix}{public_key name}.
   custom_auth_header	Determine se deve ser compatível com cabeçalhos de autenticação personalizados. Por padrão, os cabeçalhos de autenticação personalizados não são suportados. Se você ativar esse parâmetro, os valores iniciais de app_auth_header e backend_sign_header ficarão vazios, assim como quando o parâmetro estiver desativado. Se você definir o Current Value de app_auth_header, o parâmetro com o mesmo nome desse valor carregará as informações de autenticação da aplicação no cabeçalho da solicitação para APIs que usam autenticação da aplicação. Se você definir o Current Value de backend_sign_header, o parâmetro com o mesmo nome desse valor carregará as informações de assinatura no cabeçalho da solicitação de back-end para APIs vinculadas a uma política de chave de assinatura HMAC ou Basic Auth. AVISO: A configuração desse parâmetro afetará todas as APIs que usam autenticação de aplicativo ou estão vinculadas a uma política de chave de assinatura HMAC ou Basic Auth no gateway.
   gzip	Determine se as respostas devem ser compactadas usando gzip para reduzir o tráfego de rede pública. Por padrão, as respostas não são compactadas. A configuração entrará em vigor em 1 minuto. Depois de ativar este parâmetro, defina o parâmetro de nível de compactação comp_level. Quanto maior o valor, melhores as respostas serão compactadas. Padrão: 6. AVISO: Use gzip para compactar o corpo da resposta com mais de 1 KB. gzip suporta os seguintes tipos de arquivos: text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json e application/xml. Depois de ativar a compactação gzip, você deve adicionar cabeçalho de solicitação Accept-Encoding: gzip. A configuração do gzip pode ser modificada 1 minuto depois de concluída.
   custom_log	Se os logs personalizados devem ser ativados. Padrão: desativado. Uma vez ativado, os valores dos parâmetros especificados serão impressos em localizações especificadas de logs de chamadas para todas as APIs no gateway. Depois que essa função for ativada, clique em Modify e, em seguida, clique em Add para adicionar os parâmetros a serem impressos nos logs de chamadas. AVISO: Os logs personalizados imprimem apenas as solicitações iniciadas pelos clientes e não imprimem as constantes e os parâmetros do sistema definidos no APIG. Os logs personalizados podem ter um máximo de 10 campos, com um tamanho total não superior a 2 KB. Alguns caracteres especiais em valores de parâmetros serão codificados. Por exemplo, o sinal de adição (+) será codificado como um espaço, aspas duplas (") codificadas como \x22 e uma barra invertida (\) codificada como \x5C.
   sse_strategy	Se a transmissão de eventos enviados pelo servidor (SSE) deve ser ativada. Ela está desativada por padrão. Uma vez ativada, as respostas das APIs são emitidas no modo de streaming para renderização baseada em caracteres. AVISO: A configuração sse_strategy pode ser modificada 1 minuto depois de ser concluída.
   request_custom_config	Configure parâmetros de solicitação do cliente. HTTP/2: ativado por padrão. Para mais detalhes, consulte HTTP 2.0. request_body_timeout: tempo limite para o corpo de solicitação do cliente. Padrão: 8s. Modifique esse parâmetro se a condição da rede for ruim ou se o corpo da solicitação for muito grande. AVISO: A configuração da solicitação do cliente pode ser modificada 1 minuto após ser concluída.
   api_uri_no_escape	Determine se o caminho deve ser escapado no URL da API. Ele está desativado por padrão, indicando que o caminho no URL está escapado. Para obter detalhes sobre a função de não escapar de caminhos após api_uri_no_escape estar ativado, consulte Tabela 2.

   Tabela 2 Funções afetadas se o caminho não for escapado

   Função	Descrição	Caminho de definição de front-end da API	Caminho para envio de uma solicitação	Desativar api_uri_no_escape	Ativar api_uri_no_escape
   Definição de API	Caminho para que o APIG corresponda às rotas.	/{path}	/aa%2Faa	/aa/aa	/aa%2Faa
   Orquestração de parâmetros	Caminho usado pelos parâmetros de serviço de back-end.	-	-	/aa/aa	/aa%2Faa
   Redirecionamento de HTTP para HTTPS	Caminho usado para redirecionamento.	-	-	/aa/aa	/aa%2Faa
   Políticas de back-end	A condição de política é o caminho do parâmetro de entrada da solicitação.	-	-	/aa/aa	/aa%2Faa
   Política de autenticação de terceiros	Caminho transferido para o sistema de terceiros depois que a API é vinculada a uma política de autenticação de terceiros.	-	-	/aa/aa	/aa%2Faa
   Política de push de log do Kafka	Caminho de solicitação usado depois que a política de push de log do Kafka é vinculada à API.	-	-	/aa/aa	/aa%2Faa
   Canais de balanceamento de carga	Caminho usado pelo APIG para encaminhar solicitações quando o canal de balanceamento de carga usa o hash de URI.	-	-	/aa/aa	/aa%2Faa
   Back-ends do FunctionGraph	Caminho de solicitação enviado a uma função quando o tipo de back-end da API é FunctionGraph.	-	-	/aa/aa	/aa%2Faa
   Autenticação personalizada	Caminho da solicitação enviada à função quando o modo de autenticação da API é definido como Custom.	-	-	/aa/aa	/aa%2Faa