Instance de flux uip Maestro

Syntaxe et options de `uip maestro flow instance`, qui inspecte et contrôle les instances de processus de flux individuelles.

uip maestro flow instance inspecte et gouverne les instances de processus individuelles — une exécution d'un processus de flux publié. Le nom de la commande est au unique (instance), même si l'entrée de la barre latérale indique instances.

Toutes les sous-commandes nécessitent uip login et respectent les options globales. Les codes de sortie suivent le contrat standard.

This page shares its implementation with uip maestro bpmn instance — the same defects and fixes apply to both pages.

Synthèse

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> est requis sur chaque sous-commande.

Options communes

• -f, --folder-key <key> (obligatoire) — clé de dossier.
• --comment <text> (commandes d'opération uniquement) — commentaire facultatif enregistré avec l'opération. Envoyé comme une chaîne vide si omis.

Sous-commandes

Liste des instances de flux UIP Maestro

Répertoriez les instances dans un dossier, limitées aux processus de flux (processType=Flow).

Options

Option	Default	Description
-l, --limit <n>	DEFAULT_PAGE_SIZE	Number of items to return. Bounded at 1-500 — stricter than this CLI's usual 1-10000 convention, because the instances API pages by cursor rather than offset.
--next-page <cursor>	—	Cursor from a previous response's Pagination.NextPage. This API does not support --offset at all — a non-zero --offset fails fast with an error telling you to use --next-page instead.
--process-key <k>	—	Filter by process key (GUID). For the dotted package identifier, use --package-id.
--package-id <id>	—	Filtrez par ID de package.
--error-code <code>	—	Filtrez par code dʹerreur.
--status <status>	—	Filter by instance status. Repeatable (OR-semantics). Values: Canceling, Cancelled, Completed, Faulted, Paused, Pausing, Pending, Resuming, Retrying, Running, Upgrading.
--from-date <iso-8601>	—	Only include instances started at or after this timestamp, e.g. 2026-01-01T00:00:00Z.
--to-date <iso-8601>	—	Only include instances started at or before this timestamp.

Format des données

Code: "InstanceList", Data est un tableau d'objets d'instance de processus.

Obtenir l’instance de flux UIP Maestro

Récupérez une seule instance par ID.

Format des données: Code: "InstanceGet", Data est l'objet d'instance de processus.

pause d’instance de flux uip maestro

Suspendez une instance en cours d'exécution. Format des données: Code: "InstancePaused".

Reprise de l’instance de flux uip maestro

Reprenez une instance suspendue. Format des données: Code: "InstanceResumed".

annulation d’instance de flux uip maestro

Annulez une instance en cours d'exécution. Format des données: Code: "InstanceCanceled".

Réessayer l’instance de flux UIP Maestro

Réessayez une instance défaillante. Format des données: Code: "InstanceRetried".

Migration d’instance de flux uip maestro

Migrez une instance vers une version de package différente.

Arguments: <instance-id>, <new-version> (version du package cible).

Format des données: Code: "InstanceMigrated".

Variables d’instance de flux UIP Maestro

Obtenir les variables d'une instance.

Options: --parent-element-id <id> — filtrer les variables par élément parent.

Format des données: Code: "InstanceVariables", Data porte la charge utile des variables de l’instance.

uip maestro flow instance variables-set

Patch (partially update) variables for an instance.

Options

Option	Description
--inputs <value>	Patch-variables payload as a JSON string, an @file path, or piped via stdin.

Format des données

Code: "InstanceVariablesSet".

uip maestro flow instance variables-all

Get all variables for an instance, including subprocess variables (unlike variables, which is scoped to the top-level process unless --parent-element-id is passed).

Format des données

Code: "InstanceVariablesAll".

uip maestro flow instance global-variables

Get an instance's global variables (shared across the whole process, not scoped to any element).

Format des données

Code: "InstanceGlobalVariables".

uip maestro flow instance element cancel

Cancel a specific element within a running instance, rather than the whole instance.

Arguments

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

Options

• --comment <text> — optional comment recorded with the operation.

Format des données

Code: "ElementCanceled".

uip maestro flow instance element retry

Retry a specific faulted element within an instance, rather than retrying the whole instance.

Arguments

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

Options

• --comment <text> — optional comment recorded with the operation.

Format des données

Code: "ElementRetried".

uip maestro flow instance message send

Send a message to workflow subscriptions listening on this folder — used to deliver an external event into a running Flow (for example, a webhook payload the process is waiting on).

Options

Option	Description
-f, --folder-key <key>	(required) Folder key (GUID).
--inputs <value>	Message payload as a JSON string, an @file path, or piped via stdin.

Format des données

Code: "MessageSent".

incidents d’instance de flux uip maestro

Obtenir des incidents pour une instance spécifique.

Format des données: Code: "InstanceIncidents", Data est un tableau d’objets d’incident.

Ressource d’instance de flux UIP Maestro

Récupérez la définition de Flow (la ressource .flow ) associée à la version de cette instance — utile lors du débogage pour voir le graphique exact par lequel l'instance a été exécutée.

Format des données: Code: "InstanceAsset", Data est le fichier JSON du flux.

Curseurs d’instance de flux uip maestro

Obtenir les positions actuelles du curseur d'exécution — à quel(s) élément(s) l'instance est suspendue.

Format des données: Code: "InstanceCursors", Data répertorie les positions actuelles du curseur.

Instance de flux UIP Maestro - Goto

Déplacez un curseur d'exécution d'un élément à un autre. Utile pour récupérer une instance défaillante en ignorant ou en réessayant des nœuds spécifiques.

Arguments

• <instance-id> (requis)
• <transitions> (obligatoire) — Tableau JSON de transitions, chacune avec sourceElementId et targetElementId.

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

La CLI valide les analyses JSON et chaque entrée a les deux ID avant d'appeler l'API.

Format des données

Code: "InstanceGoto".

Instance des exécutions d’éléments de flux uip Maestro

Obtenez l'historique d'exécution par élément pour une instance (ce qui a été exécuté, quand et avec quel résultat).

Format des données

Code: "InstanceElementExecutions", Data correspond à l'historique d'exécution par élément.

Exemples

# 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"

Voir également

• uip maestro flow incident — incidents de lecture détachés d'une instance spécifique
• uip maestro flow job — la vue de la tâche d'une exécution d'instance
• uip maestro flow process — de nouvelles instances de démarrage
• Tâches Orchestrator
• Vue d’ensemble du flux