- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
uip 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.
Sinopsis
uip flow instance list <instance-id> -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip flow instance get <instance-id> -f <folder-key>
uip flow instance pause <instance-id> -f <folder-key> [--comment <text>]
uip flow instance resume <instance-id> -f <folder-key> [--comment <text>]
uip flow instance cancel <instance-id> -f <folder-key> [--comment <text>]
uip flow instance retry <instance-id> -f <folder-key> [--comment <text>]
uip flow instance migrate <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip flow instance variables <instance-id> -f <folder-key> [--parent-element-id <id>]
uip flow instance incidents <instance-id> -f <folder-key>
uip flow instance asset <instance-id> -f <folder-key>
uip flow instance cursors <instance-id> -f <folder-key>
uip flow instance goto <instance-id> <transitions> -f <folder-key>
uip flow instance element-executions <instance-id> -f <folder-key>
uip flow instance list <instance-id> -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip flow instance get <instance-id> -f <folder-key>
uip flow instance pause <instance-id> -f <folder-key> [--comment <text>]
uip flow instance resume <instance-id> -f <folder-key> [--comment <text>]
uip flow instance cancel <instance-id> -f <folder-key> [--comment <text>]
uip flow instance retry <instance-id> -f <folder-key> [--comment <text>]
uip flow instance migrate <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip flow instance variables <instance-id> -f <folder-key> [--parent-element-id <id>]
uip flow instance incidents <instance-id> -f <folder-key>
uip flow instance asset <instance-id> -f <folder-key>
uip flow instance cursors <instance-id> -f <folder-key>
uip flow instance goto <instance-id> <transitions> -f <folder-key>
uip flow instance element-executions <instance-id> -f <folder-key>
-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 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 a devolver (1-10000). |
--offset <n> | 0 | Número de elementos a omitir (0-1000000). |
--process-key <k> | — | Filtrar por clave de proceso. |
--package-id <id> | — | Filtrar por ID de paquete. |
--error-code <code> | — | Filtrar por código de error. |
Forma de datos
Code: "InstanceList", Data es una matriz de objetos de instancia de proceso.
obtención de instancia de flujo 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 de uip
Pausar una instancia en ejecución. Forma de datos: Code: "InstancePaused".
reanudación de la instancia de flujo de uip
Reanudar una instancia en pausa. Forma de datos: Code: "InstanceResumed".
cancelación de instancia de flujo de uip
Cancelar una instancia en ejecución. Forma de datos: Code: "InstanceCanceled".
reintento de instancia de flujo de uip
Reintentar una instancia defectuosa. Forma de datos: Code: "InstanceRetried".
Migración de instancia de flujo 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 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.
Incidentes de instancia de flujo de UIP
Obtener incidentes para una instancia específica.
Forma de datos: Code: "InstanceIncidents", Data es una matriz de objetos incidentes.
activo de instancia de flujo 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 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.
Ir a instancia de flujo de UIP
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 consourceElementIdytargetElementId.
uip flow instance goto c3d4e5f6-… \
'[{"sourceElementId":"Node_1","targetElementId":"Node_3"}]' \
--folder-key c3d4e5f6-…
uip 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 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 flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50
# Pause, fix, resume
uip flow instance pause <id> --folder-key <k> --comment "Investigating"
uip flow instance resume <id> --folder-key <k>
# Skip a faulted node by moving the cursor forward, then retry
uip flow instance cursors <id> --folder-key <k>
uip flow instance goto <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip flow instance retry <id> --folder-key <k>
# Upgrade a long-running instance to a new package version
uip flow instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
# Paginate through instances for a specific process
uip flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50
# Pause, fix, resume
uip flow instance pause <id> --folder-key <k> --comment "Investigating"
uip flow instance resume <id> --folder-key <k>
# Skip a faulted node by moving the cursor forward, then retry
uip flow instance cursors <id> --folder-key <k>
uip flow instance goto <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip flow instance retry <id> --folder-key <k>
# Upgrade a long-running instance to a new package version
uip flow instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
Ver también
uip flow incidents— leer incidentes separados de una instancia específicauip flow job: la vista de trabajo de una ejecución de instanciauip flow process— iniciar nuevas instancias- Trabajos de Orchestrator
- Descripción general del flujo
- Sinopsis
- Opciones comunes
- Subcomandos
- lista de instancias de flujo de uip
- obtención de instancia de flujo de uip
- pausa de instancia de flujo de uip
- reanudación de la instancia de flujo de uip
- cancelación de instancia de flujo de uip
- reintento de instancia de flujo de uip
- Migración de instancia de flujo de UIP
- variables de instancia de flujo de uip
- Incidentes de instancia de flujo de UIP
- activo de instancia de flujo de uip
- cursores de instancia de flujo uip
- Ir a instancia de flujo de UIP
- Ejecuciones de elementos de instancia de flujo de UIP
- Ejemplos
- Ver también