proxy

Aplique a política proxy para o proxy de outra API dentro de sua operação, especialmente se for necessário chamar uma carga útil grande.

Suporte de gateway

Tabela 1. Tabela mostrando quais gateways suportam a política e a versão da política correspondente
Gateway Versão da política
DataPower® Gateway (v5 compatible) 1.0.0
DataPower API Gateway, funcionalidade fornecida por Chamar  

Este tópico descreve como configurar a política em sua origem OpenAPI ; para obter detalhes sobre como configurar a política na interface com o usuário do conjunto, consulte Proxy.

Sobre

Lembre-se das seguintes considerações sobre a política de proxy.
  • Apenas uma política proxy pode ser chamada por conjunto.
  • Mais de uma política proxy pode ser aplicada, se elas estiverem contidas em ramificações mutuamente exclusivas do conjunto
  • É possível usar a política proxy para retornar dados de formulário multipartes, ou seja, quando a resposta for configurada comoContent-Type: multipart/related. No entanto, proxy deve ser a política final no conjunto, caso contrário, a resposta recebida será manipulada, fazendo com que os dados do formulário multipartes sejam perdidos.
  • A política proxy , se estiver dentro de uma política condicional, deve ser a política final a ser executada na API (interface de programação de aplicativos) Se precisar de processamento adicional posteriormente, use a política invoke em vez da política proxy .
  • A política de Proxy não tenta atualmente regravar um cabeçalho de Localização que é retornado do back-end.
A política proxy tem a seguinte estrutura:
- proxy:
  version: version
  title: title
  description: description
  target-url: URL_of_target_API
  tls-profile: TLS_profile_to_be_used
  verb: method_type
  http-version: HTTP_version
  timeout: timeout_value_in_seconds
  compression: is_data_to_be_compressed
  username: username_if_authentication_required
  password: password_if_authentication_required
  output: location_of_the_proxy_result
  cache-key: unique_identifier_of_the_document_cache_entry
  cache-response: cache_behavior
  cache-putpost-response: response_caching_behavior
  cache-ttl: cache_time_to_live
  stop-on-error: errors_that_stop_the_flow

Propriedades

A tabela descreve as propriedades da política de proxy.
Tabela 2. Propriedades da política de proxy
Propriedade Necessário Descrição Tipo de Dados
version True O número de versão da política sequência
title Não Um título para a política. sequência
description Não Uma descrição da política. sequência
target-url True A URL da API de destino. sequência
tls-profile Não O perfil TLS a ser usado. sequência
verb Não

O tipo de método de operação.

Valores válidos:
  • Manter
  • GET
  • POST
  • PUT
  • EXCLUIR
  • PATCH
  • HEAD
  • OPÇÕES

O valor padrão é Keep.

 sequência
http-version Não A versão de HTTP. O valor padrão é 1.1. sequência
timeout Não O valor de tempo limite em segundos. O valor padrão é 60. número inteiro
compression Não Especifica se os dados devem ser compactados usando gzip antes de serem transferidos por upload. O valor padrão é false. booleano
username Não O nome do usuário, se a autenticação for necessária. sequência
password Não A senha, se a autenticação for necessária. sequência
output Não Especifica o local do resultado do proxy. Por padrão, o resultado de proxy, que é o corpo, cabeçalhos, statusCode e statusMessage, é salvo na variável context.message. Os desenvolvedores do conjunto podem especificar um local adicional para armazenar o resultado de proxy com a propriedade de saída. sequência

cache-key

 Não Especifica o identificador exclusivo da entrada de cache do documento. sequência

cache-response

 Não O tipo de resposta de cache.
Valores válidos:
  • protocolo: O comportamento do cache é definido pelos cabeçalhos Cache-Control na solicitação e na resposta.
  • sem cache: Especifica que não há armazenamento em cache. No entanto, se o documento já estiver no cache, ele será recuperado do cache.
  • tempo de vida: Especifica que a resposta permanece no cache durante o período especificado.

O valor padrão é protocol.

 sequência
cache-putpost-response Não Especifica se você deseja armazenar em cache a resposta das solicitações POST e PUT. O armazenamento em cache da resposta das solicitações POST e PUT pode reduzir o carregamento do servidor e a latência na resposta à solicitação do cliente.

O valor padrão é false.

 booleano

cache-ttl

 Não Especifica o período de tempo, em segundos, que a resposta permanece no cache. Aplica-se apenas se a propriedade cache-response estiver configurada como time-to-live. Insira um valor no intervalo de 5 a 31708800.

O valor padrão é 900.

Observação: Quando os usuários fazem login usando o caminho de login do Toolkit (um URL que inclui ?from=TOOLKIT), a chave de API gerada tem um tempo de vida fixo (TTL) de 5 minutos.
 número inteiro
stop-on-error Não Lista os erros que, se lançados durante a execução da política, farão com que o fluxo seja interrompido. Se houver um fluxo catch configurado para este erro, ele será acionado para manipular o erro lançado. Se um erro for lançado e não houver erros especificados para a configuração Parar no erro ou se o erro lançado não for um dos erros especificados, a execução da política terá permissão para ser concluída, e o fluxo de conjuntos continuará. sequência