Configuración de la política Invoke para DataPower Gateway (v5 compatible)

Siga estos pasos para configurar la política Invoke para DataPower® Gateway (v5 compatible) en la interfaz de usuario de ensamblaje.

Acerca de esta tarea

Nota: Este tema describe la implementación de la política Invoke en DataPower Gateway (v5 compatible). Si utiliza DataPower API Gateway, consulte «Configuración de la política de invocación» en DataPower API Gateway. Para obtener información sobre los distintos tipos de pasarela, consulte Tipos de pasarela deAPI Connect.

Para obtener más información sobre cómo configurar la política en tu fuente de « OpenAPI », consulta invoke.

Es posible que observe que el último invoke de su política se ha sustituido por un proxy. El reemplazo a veces se realiza automáticamente mediante IBM® API Connect DataPower Gateway para mejorar el rendimiento. proxy es funcionalmente equivalente a invoke, pero el interlocutor de la API puede observar las siguientes diferencias cuando se utiliza proxy .

Si la solicitud de HTTP realizada por invoke o proxy obtiene una redirección (3xx). respuesta:
- invoke devuelve la respuesta siguiente a la respuesta de redirección.
- proxy no sigue3xxy se devuelve la respuesta de redirección.
La herramienta de pruebas « IBM API Connect » indica que proxy se utilizó [nombre], pero [nombre invoke ] aparece en los registros de latencia de análisis.
La respuesta de proxy puede contener un espacio en blanco o un escape distinto al de una respuesta de invoke. A pesar de las diferencias en la respuesta, sigue siendo válida.

Si desea impedir la sustitución del último invoke del ensamblaje por proxy, puede establecer la propiedad de API api.properties.x-ibm-gateway-optimize-invoke en false. Para obtener más información, consulta las propiedades de la API.

Procedimiento

En el panel de navegación, haz clic en «Desarrollo » y, a continuación, selecciona la pestaña «API ».
Se abre la página Desarrollar .
Pulse el título de la definición de API con la que desea trabajar.
Seleccione la pestaña Pasarela y, a continuación, pulse Políticas en el panel de navegación.
Para obtener más información sobre cómo trabajar con el editor de ensamblados de una API, consulta «El editor de ensamblados ».
Busque la política Invocar en la paleta y arrastre la política al lienzo.

Especifique las propiedades siguientes.

Tabla 1. Acceder a las propiedades de la política
Etiqueta de propiedad	Obligatorio	Descripción	Tipo de datos
Título	Sí	El título de la política. El valor predeterminado es `invoke`.	serie
Descripción	Nee	Una descripción de la política.	serie
URL	Sí	Especifica un URL para el servicio de destino. Para una API SOAP, se añade un URL de forma predeterminada. Cuando es posible, se proporciona el valor Invocar URL a partir de información definida en el WSDL importado.	serie
Perfil TLS	Nee	Especifica un perfil TLS que se va a utilizar para la transmisión segura de datos.	serie
Timeout	Sí	El tiempo de espera antes de una respuesta del punto final (en segundos). El valor predeterminado es `60`.	entero
Seguir redirecciones	Nee	Especifica el comportamiento si el servidor back-end devuelve el código de estado HTTP `301 Moved Permanently`. Si selecciona esta casilla de verificación, la directiva `invoke` sigue la redirección URL realizando una llamada adicional al URL especificado en el encabezado `Location` en la respuesta. Si desmarca este recuadro de selección, `invoke` guarda el código de estado `301` y se considera que la llamada de API está completa. Nota: La propiedad `follow-redirect` sólo está soportada por DataPower API Gateway. Si utilizas el DataPower Gateway (v5 compatible), el `invoke` siempre sigue la redirección URL; la `proxy` política (no compatible con el DataPower API Gateway) guarda el código `301` de estado y completa la llamada a la API sin seguir la redirección URL.	booleano
Nombre de usuario	Nee	El nombre de usuario que se va a utilizar para la autenticación básica HTTP.	serie
Contraseña	Nee	La contraseña que se va a utilizar para la autenticación básica HTTP.	serie
Método HTTP	Sí	El método HTTP que se va a utilizar para la invocación. Los siguientes valores son válidos. Conservar GET POST PUT SUPRIMIR PARCHE CABECERA OPCIONES El valor predeterminado es `GET`. Sin embargo, si se establece en `Keep`, o si la propiedad se elimina de la fuente, se utiliza el método HTTP de la solicitud entrante.	serie
Compresión	Nee	Seleccione este recuadro de selección para habilitar la compresión Content-Encoding al cargar. El recuadro de selección está desmarcado de forma predeterminada.	booleano
Tipo de memoria caché	Nee	El tipo de caché determina si se guardan documentos en caché, respetando o anulando las directrices de control de caché HTTP recibidas en la respuesta del URL de destino. Esta propiedad solamente entra en vigor cuando se recibe una respuesta, de lo contrario la política siempre devuelve la respuesta no caducada guardada anteriormente en caché. Los valores válidos son: Protocolo El comportamiento de la caché está determinado por las cabeceras Cache-Control de la respuesta, conforme a RFC 7234. Para optimizar el rendimiento, si la pasarela recibe más de una solicitud de un recurso que no está en caché pero que podría guardarse en caché cuando al recibirse la respuesta del URL de destino recibe, la pasarela solo envía una solicitud al URL de destino; el resto de peticiones no se procesan mientras no se recibe la respuesta de la primera solicitud y se determina el comportamiento de la caché a partir de dicha respuesta. Si la respuesta indica que guardar en caché es posible, la pasarela responderá con el recurso guardado caché a todas las solicitudes en espera. Si la respuesta indica que la no es posible guardar en caché, la pasarela envía todas las solicitudes en espera al URL de destino. Utilice esta opción solo si espera que las respuestas del URL de destino se pueden guardar en caché, en cuyo caso se debería mejorar el rendimiento y limitar la demanda del URL de destino. Sin embargo, si el URL de destino nunca indica que la pasarela tiene que guardar en caché su respuesta, el rendimiento podría verse penalizado respecto de la opción Sin caché. Sin memoria caché Las respuestas del URL de destino no están no se guardan en caché en la pasarela independientemente de las cabeceras de guardado en caché devueltas. En este caso, cada solicitud del cliente se envía al URL de destino. Utilice esta opción si no desea guardar en caché ninguna respuesta del backend en la pasarela, o si no es probable que una respuesta del URL de destino permita el guardado en caché mediante valores de la cabecera Cache-Control. Tiempo de vida Esta opción es similar a la opción Protocolo, salvo que permite especificar la cantidad de tiempo que se desea que permanezca en caché una respuesta satisfactoria de la invocación o del proxy. Utilice esta opción solo si espera que las respuestas del URL de destino se pueden guardar en caché. El valor predeterminado es Protocolo.	serie
Tiempo de vida	Nee	Especifica el tiempo en segundos que la respuesta permanece en la memoria caché. Sólo se aplica si la propiedad Tipo de memoria caché se establece en `Time to Live`. Entre un valor en el rango de 5 a 31708800. El valor predeterminado es `900`.	entero
Clave de memoria caché	Nee	Especifica el identificador exclusivo de la entrada de memoria caché de documento. Si se omite, se utiliza la serie URL completa como clave.	serie
Detener en caso de error	Nee	Seleccione los errores que, si se generan durante la ejecución de la política, hacen que se detenga el flujo de ensamblaje. Si hay un flujo de `catch` configurado para el error, se desencadena para manejar el error generado. Si se emite un error y no hay errores seleccionados para el valor de Detener en caso de error o si el error emitido no es uno de los errores seleccionados, se permite que se complete la ejecución de la política y el flujo de ensamblaje continúa.	serie
Variable de objeto de respuesta	Nee	El nombre de una variable que se utilizará para almacenar los datos de respuesta de la solicitud. De forma predeterminada, la respuesta de invocación, es decir el cuerpo las cabeceras, el código de estado y el mensaje de estado se guardan en la variable `message`. Utilice esta propiedad para especificar una ubicación alternativa para almacenar la respuesta de invocación. Esta variable se puede utilizar en otras acciones, como Map. Nota: Si desea que la respuesta se guarde en el `mensaje`, deje la propiedad Variable de objeto de respuesta en blanco, no proporcione el valor `message`.	serie
Almacenamiento intermedio	Nee	Selecciona «Buffering» para indicar si se desea almacenar en búfer la carga útil. Si se selecciona «Buffering», la carga útil se almacena en el búfer y la política de invocación puede comprobar el tipo de la carga útil. Si no se selecciona «Buffering», la carga útil se transmite en tiempo real y la política de invocación no puede comprobar el tipo de carga útil. Nota: Si activas el almacenamiento en búfer, también debes configurar una política de análisis para interpretar la carga útil. Sin una política de análisis, la carga útil sigue siendo un búfer sin interpretar, y la política de invocación se ejecuta correctamente si el servicio de fondo acepta cargas útiles de tipo `binary` o `detect`. Si se configura una política de análisis, esta desactiva implícitamente la transmisión en continuo, incluso si el almacenamiento en búfer está desactivado, ya que el análisis requiere que se almacene en búfer toda la carga útil. Para obtener más información, consulta Parse.	booleano

Especifica una versión para la política haciendo clic en el icono «Fuente » y completando la version sección correspondiente del archivo YAML de la política. Por ejemplo:
```
execute:
  - invoke:
      version: 1.0.0
      title: invoke
  ...
```
Debe especificar una versión para la política que sea compatible con la pasarela que está utilizando. Cuando se publica la API, si la versión es incompatible con la pasarela, se genera un error de validación que especifica las versiones disponibles.
Pulse Guardar.

Ejemplo

- invoke:
          version: 1.0.0
          title: get the account status
          timeout: 60
          verb: POST
          cache-response: time-to-live
          cache-ttl: 900
          stop-on-error:
            - ConnectionError
            - OperationError
          tls-profile: MyTLSProfile
          target-url: https://example.com/accounts/{id}?status={status}
          username: MyUser
          password: MyPassword