uip maestro flow instance

Syntax and options for `uip maestro flow instance`, which inspects and steers individual Flow process instances.

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.

Synthèse

uip maestro flow instance list                <instance-id>             -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
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 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>

-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

uip maestro flow instance list

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	Nombre d'éléments à renvoyer (1-10 000).
--offset <n>	0	Nombre d’éléments à ignorer (0-1000 000).
--process-key <k>	—	Filtrer par clé de processus.
--package-id <id>	—	Filtrez par ID de package.
--error-code <code>	—	Filtrez par code dʹerreur.

Format des données

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

uip maestro flow instance get

Récupérez une seule instance par ID.

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

uip maestro flow instance pause

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

uip maestro flow instance resume

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

uip maestro flow instance cancel

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

uip maestro flow instance retry

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

uip maestro flow instance migrate

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

uip maestro flow instance variables

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 incidents

Obtenir des incidents pour une instance spécifique.

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

uip maestro flow instance asset

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.

uip maestro flow instance cursors

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.

uip maestro flow instance 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".

uip maestro flow instance element-executions

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