proxy

Aplicar la política proxy al proxy de otra API dentro de la operación, especialmente si necesita llamar a una carga útil grande.

Soporte de pasarela

Tabla 1. Tabla que muestra qué pasarelas soportan esta política y la versión de política correspondiente
Pasarela	Versión de política
DataPower® Gateway (v5 compatible)	1.0.0
DataPower API Gateway, funcionalidad proporcionada por Invoke

En este tema se describe cómo configurar la política en el origen de OpenAPI ; para obtener detalles sobre cómo configurar la política en la interfaz de usuario de ensamblaje, consulte Proxy.

Acerca de

Tenga en cuenta las consideraciones siguientes respecto a la política proxy.

Sólo se permite llamar a una política proxy por ensamblaje.
Se puede aplicar más de una política proxy , si están contenidas en ramas mutuamente excluyentes del ensamblaje.
Puede utilizar la política proxy para devolver datos de formulario de varias partes, es decir, cuando la respuesta se establece enContent-Type: multipart/related. Sin embargo, proxy debe ser la política final en el ensamblaje, de lo contrario, la respuesta que se recibe se manipula haciendo que se pierdan los datos de formulario de varias partes.
La política proxy , si está dentro de una política condicional, debe ser la política final que se va a ejecutar en la API. Si necesita más proceso después, utilice la política invoke en lugar de la política proxy .
La política proxy no intenta actualmente volver a escribir una cabecera de ubicación que se devuelve desde el programa de fondo.

La política proxy tiene la estructura siguiente:

- 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

Propiedades

En la tabla se describen las propiedades de la política proxy.

Tabla 2. Propiedades de política proxy
Propiedad	Obligatorio	Descripción	Tipo de datos
version	Sí	El número de versión de la política	serie
title	Nee	Título de la política.	serie
description	Nee	Una descripción de la política.	serie
target-url	Sí	El URL de la API de destino	serie
tls-profile	Nee	El perfil de TLS que se va a utilizar.	serie
verb	Nee	El tipo de método de operación. Valores válidos: Conservar GET POST PUT ELIMINAR PARCHE HEAD OPCIONES El valor predeterminado es `Keep`.	serie
http-version	Nee	La versión de HTTP. El valor predeterminado es `1.1`.	serie
timeout	Nee	El valor del tiempo de espera en segundos. El valor predeterminado es `60`.	entero
compression	Nee	Especifica si los datos se deben comprimir mediante gzip antes de cargarlos. El valor predeterminado es `false`.	booleano
username	Nee	El nombre de usuario si se necesita autenticación.	serie
password	Nee	La contraseña si se necesita autenticación.	serie
output	Nee	Especifica la ubicación del resultado de proxy. De forma predeterminada, el resultado de proxy, es decir, el cuerpo, las cabeceras, el código de estado y el mensaje de estado, se guarda en la variable `context.message`. Los desarrolladores de ensamblaje pueden especificar una ubicación adicional para almacenar el resultado del proxy con la propiedad output.	serie
cache-key	Nee	Especifica el identificador exclusivo de la entrada de memoria caché de documento.	serie
cache-response	Nee	El tipo de puesta en caché de la respuesta. Valores válidos: protocol: el comportamiento de la memoria caché está definido para las cabeceras Cache-Control de la solicitud y la respuesta. no-cache: especifica que no hay puesta en memoria caché. Sin embargo, si el documento ya está en la memoria caché, el documento se recupera de la memoria caché. time-to-live: especifica que la respuesta permanece en la memoria caché durante el tiempo especificado. El valor predeterminado es `protocol`.	serie
cache-putpost-response	Nee	Especifica si se debe poner en memoria caché la respuesta de las solicitudes POST y PUT. El almacenamiento en memoria caché de la respuesta de las solicitudes POST y PUT puede reducir la carga y reducir la latencia en la respuesta a la solicitud del cliente. El valor predeterminado es `false`.	booleano
cache-ttl	Nee	Especifica el tiempo en segundos que la respuesta permanece en la memoria caché. Solo se aplica si la propiedad cache-response está establecida en `time-to-live`. Entreun valor en el rango de 5 a 31708800. El valor predeterminado es `900`. Nota: Cuando los usuarios inician sesión utilizando la ruta de inicio de sesión del Toolkit (una URL que incluye `?from=TOOLKIT`), la clave de API generada tiene un tiempo de vida (TTL) fijo de 5 minutos.	entero
stop-on-error	Nee	Lista los errores que, si se generan durante la ejecución de la política, provocan la detención del flujo. Si hay un flujo de `catch` configurado para el error, se desencadena para manejar el error generado. Si se genera un error y no hay errores especificados para la propiedad Detener en caso de error o si el error generado no es uno de los errores especificados, se permite que la ejecución de la política se complete y el flujo del ensamblaje continúa.	serie