Documentación de Oracle Cloud Infrastructure

Especificación de los criterios de finalización mediante sondeo

Para una tarea REST que llama a una operación de API de REST de larga ejecución, seleccione la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera en el paso Especificar los criterios de finalización para especificar la configuración de sondeo para identificar la finalización de la llamada de REST.

Además de la condición correcta, la configuración de sondeo incluye una condición y una URL de REST de sondeo, y valores para un intervalo de sondeo y un timeout de sondeo.

Opcionalmente, puede especificar una configuración de terminación para cancelar la operación de API de larga ejecución.

Para utilizar la respuesta de API del paso de ejecución en la configuración de sondeo o terminación, cree expresiones y, a continuación, incluya las expresiones con nombre en las URL de sondeo y terminación, así como las condiciones de sondeo y correctas.

Antes de configurar el sondeo o la terminación, cree las expresiones para recuperar los valores de respuesta de API que necesita.

Consulte también Sondeo en operaciones de larga ejecución.

Adición de expresiones para su uso en sondeos

Las expresiones permiten asignar un valor o una expresión a una variable que luego puede utilizar al configurar el paso de criterios de finalización.

Cree expresiones que utilicen la respuesta de la API del paso de ejecución de REST. Al crear la expresión se le proporciona un nombre. Para incluir la expresión con nombre en la URL de sondeo o terminación, o la condición de sondeo o correcta, utilice la sintaxis #{expression_name}.

Por ejemplo, si la tarea de REST llama a la operación de API para crear un proyecto mediante un nombre de proyecto específico, la solicitud de sondeo puede comprobar la clave del proyecto para determinar si el sondeo para o se detiene. Para utilizar la clave de proyecto como variable en la URL de sondeo, cree una expresión que extraiga la clave de la respuesta de carga útil de API, convirtiéndola en un valor de tipo de dato String o JSON_TEXT.

Tenga en cuenta que una expresión que cree aquí no se puede utilizar como salida de tarea de REST en otros operadores que están descendiendo de la tarea.

Para agregar una expresión:

  1. En la página Configurar los detalles de la API de REST, en el paso Especificar los criterios de finalización, seleccione la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera.
  2. Expanda la sección Expresiones y, a continuación, seleccione Agregar expresión.
  3. En el panel Agregar Expresión, sección Información de Expresión, realice lo siguiente:
    1. Introduzca un nombre para la expresión en el campo Identificador.
    2. En el menú Tipo de datos, seleccione un tipo para esta expresión.
    3. Complete los campos de propiedad para el tipo de datos seleccionado. Por ejemplo, introduzca una longitud para el tipo de datos STRING.
  4. En la sección Creador de expresiones, puede crear visualmente una expresión haciendo clic dos veces o arrastrando salidas de respuesta de entrada, parámetros o funciones para agregarlos al editor a fin de crear la expresión. O puede escribir manualmente la expresión usted mismo. Cree una expresión que utilice la salida de la respuesta de la solicitud de REST.

    • Entrada: puede utilizar las salidas del sistema SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON y SYS.RESPONSE_STATUS.

    • Parámetros: puede utilizar cualquier parámetro definido en el ámbito de esta tarea de REST. Consulte Visualización y gestión de parámetros en una tarea de REST.

    • Funciones: puede utilizar las funciones String y Operator básicas de Data Integration.

    No todas las funciones están soportadas al crear la expresión. Consulte la lista soportada aquí.

    Para extraer valores de propiedad JSON del cuerpo de respuesta de API, utilice la función String json_path con la salida de respuesta de entrada SYS.RESPONSE_PAYLOAD. Por ejemplo:

    CAST(json_path(SYS.RESPONSE_PAYLOAD_JSON, '$.key') AS String)
    CAST(json_path(SYS.RESPONSE_PAYLOAD_JSON, '$.emp.ID') AS JSON_TEXT)
  5. Seleccione Agregar.
Edición o supresión de expresiones en un sondeo

Puede editar y suprimir expresiones que haya creado en el sondeo.

Para editar o suprimir una expresión:

  1. En la página Configurar los detalles de la API de REST, en el paso Especificar los criterios de finalización, amplíe la sección Expresiones.
  2. En la tabla Expresiones, busque la expresión que desea editar o suprimir.
  3. En el menú Acciones (Acciones, menú) de la expresión, seleccione Editar o Suprimir.
    • En el panel Editar expresión, realice los cambios y, a continuación, seleccione Guardar.
    • En el recuadro de diálogo Suprimir expresión, confirme que la expresión con nombre es la que desea suprimir y seleccione Suprimir.
Configuración del método HTTP de sondeo y la URL

En una operación de API de larga ejecución, defina el método HTTP y la URL para sondear el estado de la llamada REST.

De forma similar a la URL de REST en el paso de ejecución, puede incluir parámetros en la URL de sondeo mediante la sintaxis ${parameter_name}.

Además, puede incluir expresiones con nombre mediante la sintaxis #{expression_name}. Cree las expresiones que necesite antes de configurar la URL de sondeo.

Para configurar el método de sondeo y la URL:

  1. En la página Configurar los detalles de la API de REST, en el paso Especificar los criterios de finalización, seleccione la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera.
  2. En el separador Sondeo, seleccione el método HTTP HTTP que desea utilizar para la URL de sondeo.
  3. En el campo URL, introduzca la URL completa y haga clic en Intro.

    Si se utiliza la sintaxis del parámetro ${} para partes de la URL, esas partes se convierten en parámetros de URL para la tarea de REST.

    La tabla del separador Parámetros de URL debajo del campo URL se actualiza con las partes parametrizadas. El tipo de datos por defecto para cada parámetro de URL es String.

    Si edita la URL en cualquier momento agregando o eliminando sintaxis de parámetros, la tabla de parámetros de URL se actualiza en consecuencia.

  4. Para asignar un valor por defecto a un parámetro, consulte Configuración de parámetros de URL.
  5. Para mostrar u ocultar la URL a través de los valores por defecto de parámetro que ha configurado, seleccione Mostrar URL a vista previa u Ocultar URL a vista previa.
  6. Para agregar una cabecera, consulte Adición y gestión de una cabecera.
  7. Si es necesario un cuerpo de solicitud, consulte Cómo proporcionar un cuerpo de solicitud.
Especificación de la condición de sondeo

La configuración de sondeo incluye una condición de sondeo y valores para un intervalo de sondeo y un timeout de sondeo.

La condición de sondeo es una expresión que determina si el sondeo se para o continúa. Cuando la expresión devuelve false, el sondeo se para.

Data Integration emite una llamada de sondeo varias veces en el intervalo de sondeo especificado hasta que se alcanza el valor del timeout de sondeo especificado o hasta que la condición de sondeo devuelve false, lo que ocurra primero.

Para configurar la condición de sondeo:

  1. En la página Configurar los detalles de la API de REST, en el paso Especificar los criterios de finalización, seleccione la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera.
  2. En el separador Sondeo, sección Condiciones, realice lo siguiente:
    1. Junto a Condición de sondeo, seleccione Crear.
    2. En el panel Crear condición de sondeo, introduzca una expresión que utilice la salida de la respuesta de la solicitud de REST.

      La expresión de condición puede incluir los siguientes elementos:

      • Entrada: salidas de respuesta entrantes (por ejemplo, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

      • Parámetros: parámetros definidos en el ámbito de esta tarea de REST. Consulte Visualización y gestión de parámetros en una tarea de REST.

      • Funciones: funciones básicas de integración de datos de cadena y operador. La función json_path, que se encuentra en String, permite extraer valores de propiedad de la respuesta mediante elementos de sintaxis JSONPath con el formato: json_path(json_string, json_filter_path)

      Por ejemplo: CAST(json_path(SYS.RESPONSE_PAYLOAD, '$.name') AS String) != 'My_Project'

  3. En la sección Condiciones, debajo de Condición de análisis, introduzca un valor y seleccione una unidad de medida para Intervalo de análisis y Timeout de análisis.
    • Timeout de sondeo: período de tiempo máximo que se permite para que se repita el sondeo en el ratio de intervalo especificado. El valor de timeout debe ser mayor o igual que 120 segundos, pero menor o igual que 30 días.
    • Intervalo de sondeo: tiempo de espera antes de enviar la siguiente solicitud. El valor de intervalo debe ser mayor o igual que 60 segundos y menor que el valor de timeout especificado.
  4. Para asignar un parámetro de tarea a la condición, seleccione Asignar parámetro. Consulte Parametrización de la condición de sondeo.
Parametrización de la condición de sondeo

Después de agregar una condición de sondeo, puede asignar un parámetro de tarea a la condición.

Para establecer parámetros de la condición de sondeo en una tarea de REST:

  1. En la página Configurar los detalles de la API de REST, vaya al paso Especificar los criterios de finalización.
  2. En el bloque Condiciones, junto a Condición de sondeo, seleccione Asignar parámetro.
  3. En el panel Agregar parámetro, introduzca un nombre para el parámetro en el campo Identificador o utilice el valor por defecto.

    El nombre de parámetro debe ser único en la tarea de REST. Para obtener una lista actual de los parámetros de la tarea, consulte Visualización de todos los parámetros en una tarea de REST.

  4. (Opcional) Introduzca una Descripción para ayudar a identificar la finalidad del parámetro a otros usuarios.
  5. El tipo del parámetro es Expresión, que no puede cambiar.
  6. En el creador de condiciones, defina la expresión de condición por defecto para este parámetro. Esta condición por defecto se utiliza en tiempo de ejecución, a menos que cambie el valor más adelante (en tiempo de diseño o en tiempo de ejecución).

    La expresión de condición puede incluir los siguientes elementos:

    • Entrada: salidas de respuesta entrantes (por ejemplo, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Parámetros: parámetros definidos en el ámbito de esta tarea de REST. Consulte Visualización y gestión de parámetros en una tarea de REST.

    • Funciones: funciones básicas de integración de datos de cadena y operador. La función json_path, que se encuentra en String, permite extraer valores de propiedad de la respuesta mediante elementos de sintaxis JSONPath con el formato: json_path(json_string, json_filter_path)

    Por ejemplo: CAST(json_path(SYS.RESPONSE_PAYLOAD, '$.name') AS String) != 'My_Project'

  7. Seleccione Agregar.
    El nombre del parámetro se agrega junto a la condición de sondeo.
Edición del parámetro de condición de sondeo

Puede cambiar la descripción y el valor por defecto del parámetro de tarea para la condición de sondeo.

Para editar la condición de sondeo con parámetros:

  1. En la página Configurar los detalles de la API de REST, vaya al paso Especificar los criterios de finalización.
  2. En el bloque Condiciones, seleccione Editar parámetro.
  3. En el panel Editar parámetro, solo puede editar la descripción y la expresión de la condición de sondeo. No puede cambiar el identificador (nombre) ni el tipo de datos.
  4. Seleccione Guardar cambios.
Eliminación del parámetro de condición de sondeo

Al eliminar el parámetro de condición, solo se elimina la asociación del parámetro a la condición de sondeo especificada para la tarea REST.

Para anular la asignación del parámetro de la condición de sondeo:

  1. En la página Configurar los detalles de la API de REST, vaya al paso Especificar los criterios de finalización.
  2. En el bloque Condiciones, seleccione Eliminar parámetro.
  3. En el cuadro de diálogo Eliminar parámetro, seleccione Eliminar.

    El parámetro no está asignado a la condición de sondeo. La expresión de condición que se ha asignado al parámetro se convierte en la condición de sondeo por defecto para la tarea de REST.

    Nota

    El parámetro no se suprime de la tarea de REST. Para suprimir el parámetro, consulte Supresión de un parámetro de tarea de REST.
Configuración del método HTTP de terminación y la URL

Para una tarea de REST que llama a una operación de API de REST de larga ejecución, puede especificar los detalles de la API de REST para terminar la operación de larga ejecución.

En el separador Terminación, defina el método HTTP y la URL para terminar la llamada REST.

De forma similar a la URL de sondeo, puede incluir parámetros y expresiones en la URL de terminación mediante la sintaxis ${parameter_name} y #{expression_name}. Cree las expresiones que necesite antes de configurar la URL de terminación.

Para configurar el método de terminación y la URL:

  1. En la página Configurar los detalles de la API de REST, en el paso Especificar los criterios de finalización, seleccione la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera.
  2. En el separador Terminación, seleccione el método HTTP que desea utilizar para la URL.
  3. En el campo URL, introduzca la URL completa y haga clic en Intro.

    Si se utiliza la sintaxis del parámetro ${} para partes de la URL, esas partes se convierten en parámetros de URL para la tarea de REST.

    La tabla del separador Parámetros de URL debajo del campo URL se actualiza con las partes parametrizadas. El tipo de datos por defecto para cada parámetro de URL es String.

    Si edita la URL en cualquier momento agregando o eliminando sintaxis de parámetros, la tabla de parámetros de URL se actualiza en consecuencia.

  4. Para asignar un valor por defecto a un parámetro, consulte Configuración de parámetros de URL.
  5. Para mostrar u ocultar la URL con los valores por defecto del parámetro que ha configurado, seleccione Mostrar URL a vista previa u Ocultar URL a vista previa.
  6. Para agregar una cabecera, consulte Adición y gestión de una cabecera.
  7. Si es necesario un cuerpo de solicitud, consulte Cómo proporcionar un cuerpo de solicitud.
Especificación de los criterios de finalización (condición correcta)

La condición correcta en una tarea de REST es una expresión que determina que la llamada de API de REST se ha completado correctamente. El sondeo se para cuando se cumple la condición correcta.

Por defecto, Data Integration proporciona una condición correcta para una tarea de REST. La condición correcta por defecto es un código de estado HTTP de 200 o superior, pero inferior a 300, escrito como la siguiente expresión:

SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300

La expresión de condición correcta hace referencia a la salida en la respuesta de JSON que se recibe de la solicitud de REST definida en el paso de ejecución.

Puede utilizar la condición correcta por defecto o puede escribir una expresión de condición mediante salidas del sistema o valores de propiedad JSON extraídos de la respuesta.

Para editar la condición correcta:

  1. En la página Configurar los detalles de la API de REST, vaya al paso Especificar los criterios de finalización.
  2. Si la API de REST llama a una operación de larga ejecución, active la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera.
  3. En el bloque Condiciones, junto a Condición correcta, seleccione Editar.
  4. En el panel Editar condición correcta, introduzca una expresión que utilice la salida de la respuesta de la solicitud de REST.

    La expresión de condición puede incluir los siguientes elementos:

    • Entrada: puede utilizar las salidas de respuesta entrantes (por ejemplo, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Parámetros: puede utilizar cualquier parámetro definido en el ámbito de esta tarea de REST. Consulte Visualización y gestión de parámetros en una tarea de REST.

    • Funciones: puede utilizar las funciones String y Operator básicas de Data Integration. La función json_path, que se encuentra en String, permite extraer valores de propiedad de la respuesta mediante elementos de sintaxis JSONPath con el formato: json_path(json_string, json_filter_path)

      Por ejemplo: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

    No todas las funciones están soportadas en una expresión de condición correcta. Consulte la lista soportada aquí.

    (Para operaciones de larga ejecución) Si ha seleccionado la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera, la condición correcta es una expresión que se escribe en la respuesta de la solicitud de sondeo. Puede crear expresiones que utilicen la respuesta de API del paso de ejecución y, a continuación, incluir las expresiones con nombre para crear la condición correcta.

  5. Para asignar un parámetro de tarea a la condición correcta, seleccione Asignar parámetro. Consulte Parametrización de la condición correcta.