instancia de flujo maestro de uip

Sintaxis y opciones para la `instancia de flujo maestro de uip`, que inspecciona y dirige las instancias de proceso de flujo individuales.

uip maestro flow instance y dirige instancias de proceso individuales: una ejecución de un proceso de flujo publicado. El nombre del comando es singular (instance) aunque la entrada de la barra lateral dice instances.

Todos los subcomandos requieren uip login y respetan las opciones globales. Los códigos de salida siguen el contrato estándar.

Esta página comparte su implementación con uip maestro bpmn instance : los mismos defectos y correcciones se aplican a ambas páginas.

Sinopsis

uip maestro flow instance list                <instance-id>             -f <folder-key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
uip maestro flow instance get                 <instance-id>             -f <folder-key>
uip maestro flow instance pause               <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance resume              <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance cancel              <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance retry               <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro flow instance variables           <instance-id>             -f <folder-key> [--parent-element-id <id>]
uip maestro flow instance variables-set       <instance-id>             -f <folder-key> --inputs <json|@file>
uip maestro flow instance variables-all       <instance-id>             -f <folder-key>
uip maestro flow instance global-variables    <instance-id>             -f <folder-key>
uip maestro flow instance incidents           <instance-id>             -f <folder-key>
uip maestro flow instance asset               <instance-id>             -f <folder-key>
uip maestro flow instance cursors             <instance-id>             -f <folder-key>
uip maestro flow instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro flow instance element-executions  <instance-id>             -f <folder-key>
uip maestro flow instance element cancel      <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro flow instance element retry       <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro flow instance message send        -f <folder-key> [--inputs <json|@file>]

-f, --folder-key <key> es necesario en cada subcomando.

Opciones comunes

• -f, --folder-key <key> (obligatorio) : clave de carpeta (GUID).
• --comment <text> solo comandos de operación) : comentario opcional grabado con la operación. Enviado como una cadena vacía si se omite.

Subcomandos

lista de instancias de flujo maestro de uip

Enumerar instancias en una carpeta, con ámbito de procesos de flujo (processType=Flow).

Opciones

Opción	Predeterminado	Descripción
-l, --limit <n>	DEFAULT_PAGE_SIZE	Número de elementos que se van a devolver. Limitado a 1-500 : más estricto que la convención habitual 1-10000 de esta CLI, porque las instancias API paginan por cursor en lugar de desplazamiento.
--next-page <cursor>	—	Cursor de Pagination.NextPage de una respuesta anterior. Esta API no admite --offset en absoluto: un --offset distinto de cero falla rápidamente con un error que te indica que utilices --next-page en su lugar.
--process-key <k>	—	Filtrar por clave de proceso (GUID). Para el identificador de paquete punteado, utiliza --package-id.
--package-id <id>	—	Filtrar por ID de paquete.
--error-code <code>	—	Filtrar por código de error.
--status <status>	—	Filtrar por estado de instancia. Repetible (semántica OR). Valores: Canceling, Cancelled, Completed, Faulted, Paused, Pausing, Pending, Resuming, Retrying, Running, Upgrading.
--from-date <iso-8601>	—	Incluir solo las instancias iniciadas en o después de esta marca de tiempo, por ejemplo 2026-01-01T00:00:00Z.
--to-date <iso-8601>	—	Incluir solo las instancias iniciadas en o antes de esta marca de tiempo.

Forma de datos

Code: "InstanceList", Data es una matriz de objetos de instancia de proceso.

Obtener instancia de flujo maestro de uip

Obtener una sola instancia por ID.

Forma de datos: Code: "InstanceGet", Data es el objeto de instancia de proceso.

pausa de instancia de flujo maestro de uip

Pausar una instancia en ejecución. Forma de datos: Code: "InstancePaused".

reanudación de la instancia de flujo maestro de uip

Reanudar una instancia en pausa. Forma de datos: Code: "InstanceResumed".

cancelación de instancia de flujo maestro de uip

Cancelar una instancia en ejecución. Forma de datos: Code: "InstanceCanceled".

reintento de instancia de flujo maestro de uip

Reintentar una instancia defectuosa. Forma de datos: Code: "InstanceRetried".

Migración de instancia de flujo maestro de uip

Migra una instancia a una versión de paquete diferente.

Argumentos: <instance-id>, <new-version> (versión del paquete de destino).

Forma de datos: Code: "InstanceMigrated".

variables de instancia de flujo maestro de uip

Obtener variables para una instancia.

Opciones: --parent-element-id <id> — filtrar variables por elemento principal.

Forma de datos: Code: "InstanceVariables", Data lleva la carga útil de las variables de instancia.

conjunto de variables de instancia de flujo maestro de uip

Parchear (actualizar parcialmente) variables para una instancia.

Opciones

Opción	Descripción
--inputs <value>	Carga útil de variables de parche como una cadena JSON, una ruta @file o canalizada a través de la entrada estándar.

Forma de datos

Code: "InstanceVariablesSet".

variables de instancia de flujo maestro de uip-all

Obtener todas las variables para una instancia, incluidas las variables de subproceso (a diferencia de variables, que se limita al proceso de nivel superior a menos que se pase --parent-element-id).

Forma de datos

Code: "InstanceVariablesAll".

Variables globales de la instancia de flujo maestro de UIP

Obtener las variables globales de una instancia (compartidas en todo el proceso, sin ámbito de ningún elemento).

Forma de datos

Code: "InstanceGlobalVariables".

cancelación de elemento de instancia de flujo maestro de uip

Cancela un elemento específico dentro de una instancia en ejecución, en lugar de toda la instancia.

Argumentos

• <instance-id> (obligatorio)
• <element-id> (obligatorio)

Opciones

• --comment <text> — comentario opcional grabado con la operación.

Forma de datos

Code: "ElementCanceled".

reintento de elemento de instancia de flujo maestro de uip

Reintentar un elemento defectuoso específico dentro de una instancia, en lugar de reintentar toda la instancia.

Argumentos

• <instance-id> (obligatorio)
• <element-id> (obligatorio)

Opciones

• --comment <text> — comentario opcional grabado con la operación.

Forma de datos

Code: "ElementRetried".

Envío de mensaje de instancia de flujo maestro de uip

Enviar un mensaje a las suscripciones de flujo de trabajo que escuchan en esta carpeta: se utiliza para entregar un evento externo en un flujo en ejecución (por ejemplo, una carga útil de webhook que el proceso está esperando).

Opciones

Opción	Descripción
-f, --folder-key <key>	(obligatorio) Clave de carpeta (GUID).
--inputs <value>	Carga útil del mensaje como una cadena JSON, una ruta @file o canalizada a través de la entrada estándar.

Forma de datos

Code: "MessageSent".

Incidentes de instancia de flujo de uip maestro

Obtener incidentes para una instancia específica.

Forma de datos: Code: "InstanceIncidents", Data es una matriz de objetos incidentes.

activo de instancia de flujo maestro de uip

Obtener la definición de flujo (el activo .flow ) adjunta a la versión de esta instancia: útil al depurar para ver el gráfico exacto que ejecutó la instancia.

Forma de datos: Code: "InstanceAsset", Data es el flujo JSON.

cursores de instancia de flujo maestro de uip

Obtener las posiciones actuales del cursor de ejecución: en qué elemento(s) se detiene la instancia.

Forma de datos: Code: "InstanceCursors", Data enumera las posiciones actuales del cursor.

instancia de flujo maestro de uip ir a

Mueve un cursor de ejecución de un elemento a otro. Útil para recuperar una instancia defectuosa omitiendo o reintentando nodos específicos.

Argumentos

• <instance-id> (obligatorio)
• <transitions> (obligatorio) : matriz JSON de transiciones, cada una con sourceElementId y targetElementId.

uip maestro flow instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Node_1","targetElementId":"Node_3"}]' \
  --folder-key c3d4e5f6-…

La CLI valida los análisis JSON y cada entrada tiene ambos ID antes de llamar a la API.

Forma de datos

Code: "InstanceGoto".

Ejecuciones de elementos de instancia de flujo maestro de uip

Obtén el historial de ejecución por elemento para una instancia (qué se ejecutó, cuándo y con qué resultado).

Forma de datos

Code: "InstanceElementExecutions", Data es el historial de ejecución por elemento.

Ejemplos

# Paginate through instances for a specific process
uip maestro flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50

# Pause, fix, resume
uip maestro flow instance pause   <id> --folder-key <k> --comment "Investigating"
uip maestro flow instance resume  <id> --folder-key <k>

# Skip a faulted node by moving the cursor forward, then retry
uip maestro flow instance cursors <id> --folder-key <k>
uip maestro flow instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro flow instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro flow instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"

Ver también

• uip maestro flow incident — leer incidentes separados de una instancia específica
• uip maestro flow job : la vista de trabajo de una ejecución de instancia
• uip maestro flow process — iniciar nuevas instancias
• Trabajos de Orchestrator
• Descripción general del flujo