Ir para o conteúdo

Arquivo de configuração do gateway da API `gatewayconfig.yaml`

Introdução

Esta página descreve o principal arquivo de configuração para gateways de API privados, gatewayconfig.yaml. Ele é encontrado em /usr/local/openresty/nginx/conf/onpremise/ no Linux e Docker.

Chaves e valores de `gatewayconfig.yaml`

Chave	Padrão	Descrição
`APILogPath`	`/usr/local/hostedfiles/apilogs/`	Caminho do arquivo de log da API.
`CloudPassword`	(Nenhum)	Senha da conta Jitterbit Harmony.
`CloudUser`	(Nenhum)	Nome de login da conta Jitterbit Harmony (geralmente seu endereço de e-mail). A conta deve ter acesso às suas APIs.
`DebugMessageTruncateSize`	`5000`	Truncar mensagens que excedem esse tamanho (em bytes). Não altere a menos que instruído pelo suporte da Jitterbit.
`GlobalHitsPerMinuteDefault`	`10`	Limite de acessos globais por minuto. Não altere a menos que instruído pelo suporte da Jitterbit.
`InfluxDB_pass`	(Nenhum)	Senha do InfluxDB.
`InfluxDB_user`	(Nenhum)	Nome de usuário do InfluxDB.
`LogFile_Detail`	`true`	Se `true`, habilita o registro detalhado (mostrando todos os campos). Os arquivos aparecem no diretório especificado por `APILogPath`.
`LogFile_Enabled`	`true`	Se `true`, habilita o registro.
`LogFile_Format`	`CSV`	Formato do arquivo de log. Valores possíveis: `CSV`, `JSON`.
`LogFile_NewEveryXHours`	`1`	Cria um novo arquivo de log neste período horário.
`LogFile_Summary`	`false`	Se `true`, habilita o registro resumido (mostrando alguns campos). Os arquivos aparecem no diretório especificado por `APILogPath`.
`LogglyToken`	(Nenhum)	Token do Loggly.
`LogglyURL`	(Nenhum)	URL do Loggly.
`MaxDomainParts`	`10`	Número máximo de níveis de subdomínio suportados em um nome de domínio totalmente qualificado (FQDN). Disponível desde a versão 12.9. Não presente em `gatewayconfig.yaml` por padrão; adicione esta chave manualmente para suportar mais de 10 níveis de subdomínio.
`VerifyPayloadAttempts`	`0`	Número de tentativas para verificar a carga útil. Se 0, desabilita a verificação da carga útil. Pode causar degradação de desempenho. Use apenas para depuração de problemas de disco. Não altere a menos que instruído pelo suporte da Jitterbit.
`VerifyPayloadCompression`	`false`	Se `true`, verifica a compressão da carga útil. Não altere a menos que instruído pelo suporte da Jitterbit.
`VerifyPayloadDelayMs`	`100`	Atraso na verificação da carga útil (milissegundos). Não altere a menos que instruído pelo suporte da Jitterbit.
`apicacheInvalidORGsec`	`600`	Período de cache de metadados (segundos). Não altere a menos que instruído pelo suporte da Jitterbit.
`apicachelongexpiresec`	`21600`	Período de cache de metadados (segundos). Não altere a menos que instruído pelo suporte da Jitterbit.
`apicachetimesec`	`300`	Período de cache de metadados (segundos). Não altere a menos que instruído pelo suporte da Jitterbit.
`authTokenCacheExpiration`	`300`	Período de expiração do token de autorização (segundos). Não altere a menos que instruído pelo suporte da Jitterbit.
`autodeletepayloadfiles`	`true`	Se `true`, exclui automaticamente os arquivos de carga útil. Não altere a menos que instruído pelo suporte da Jitterbit.
`cloudtimeoutsec`	`30`	Período de tempo limite de conectividade da Jitterbit (segundos). Não altere a menos que instruído pelo suporte da Jitterbit.
`corsaccesscontrolmaxage`	`1800`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`deletepayloadfilesaftersec`	`15`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`filecleanupagehours`	`25`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`filecleanupintervalsec`	`3600`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`isonpremise`	`true`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`jbservicesurl`	`https://services.jitterbit.net/apis`	URL dos serviços Jitterbit. Clientes da EMEA devem definir isso como `https://services.jitterbit.eu/apis`.
`logcleanupagehours`	`72`	Limpar (excluir) arquivos de log após este número de horas.
`maxpayloadsize`	`20971520`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`nginxinstallpath`	`/usr/local/openresty/nginx/`	Localização da instalação do Nginx.
`oauthTokenCacheExpireSec`	`300`	Expiração do cache OAuth. (Por razões de desempenho, os tokens OAuth são armazenados em cache. A validação externa é feita após a expiração.) Não altere a menos que instruído pelo suporte da Jitterbit.
`orgID`	(Nenhum)	Defina isso se suas APIs não estiverem em sua organização padrão.
`payloaddlsizethreshold`	`1000`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`payloadrequestslocalpath`	`/usr/local/hostedfiles/payloads/`	Caminho das solicitações de carga útil.
`payloadresponseslocalpath`	`/usr/local/hostedfiles/responses/`	Caminho das respostas de carga útil.
`payloadurlpath`	/`payloads`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`payloadurlprefix`	`https://`	Para uso interno. Não altere a menos que instruído pelo suporte da Jitterbit.
`proxyEnabled`	`false`	Se `true`, habilita o suporte ao servidor proxy.
`proxyIgnoredHosts`	(Nenhum)	Lista separada por vírgulas de nomes de host que devem ignorar o proxy.
`proxyPassword`	(Nenhum)	Senha do servidor proxy, codificada em base64.
`proxyUri`	(Nenhum)	URI do servidor proxy, incluindo o número da porta. (Exemplos: `http://192.168.1.64:808`, `http://myProxyService.com:808`)
`proxyUser`	(Nenhum)	Nome de usuário do servidor proxy, codificado em base64.
`traceLogsEnabled`	`false`	Se `true`, habilita o registro de rastreamento. Quando habilitado, os logs de rastreamento aparecem em `/usr/local/openresty/nginx/logs/trace-logs/trace.log`.