uip maestro flow instance

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

uip maestro flow instance überprüft und steuert einzelne Prozessinstanzen – eine Ausführung eines veröffentlichten Flow-Prozesses. Der Befehlsname ist Singular (instance), obwohl der Seitenleisteneintrag instances lautet.

Alle Unterbefehle erfordern uip login und berücksichtigen globale Optionen. Austrittscodes folgen dem Standardvertrag.

Zusammenfassung

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> ist für jeden Unterbefehl erforderlich.

Allgemeine Optionen

• -f, --folder-key <key> (erforderlich) – Ordnerschlüssel (GUID).
• --comment <text> (nur Vorgangsbefehle) – optionaler Kommentar, der mit dem Vorgang aufgezeichnet wurde. Wird als leere Zeichenfolge gesendet, wenn er nicht angegeben wird.

Unterbefehle

uip maestro flow instance list

Listen Sie Instanzen in einem Ordner auf, die auf Flow-Prozesse (processType=Flow) beschränkt sind.

Optionen

Option	Standard	Beschreibung
-l, --limit <n>	DEFAULT_PAGE_SIZE	Anzahl der zurückzugebenden Elemente (1–10.000).
--offset <n>	0	Anzahl der zu überspringenden Elemente (0-1000000).
--process-key <k>	–	Nach Prozessschlüssel filtern.
--package-id <id>	–	Filtern Sie nach Paket-ID.
--error-code <code>	–	Nach Fehlercode filtern.

Datenform

Code: "InstanceList", Data ist ein Array von Prozessinstanzobjekten.

uip maestro flow instance get

Rufen Sie eine einzelne Instanz nach ID ab.

Datenform: Code: "InstanceGet", Data ist das Prozessinstanzobjekt.

uip maestro flow instance pause

Eine laufende Instanz anhalten. Datenform: Code: "InstancePaused".

uip maestro flow instance resume

Setzen Sie eine angehaltene Instanz fort. Datenform: Code: "InstanceResumed".

uip maestro flow instance cancel

Bricht eine laufende Instanz ab. Datenform: Code: "InstanceCanceled".

uip maestro flow instance retry

Eine fehlerhafte Instanz wiederholen. Datenform: Code: "InstanceRetried".

uip maestro flow instance migrate

Migrieren Sie eine Instanz zu einer anderen Paketversion.

Argumente: <instance-id>, <new-version> (Zielpaketversion).

Datenform: Code: "InstanceMigrated".

uip maestro flow instance variables

Rufen Sie Variablen für eine Instance ab.

Optionen: --parent-element-id <id> – Filtern Sie Variablen nach dem übergeordneten Element.

Datenform: Code: "InstanceVariables", Data trägt die Nutzlast der Instanzvariablen.

uip maestro flow instance incidents

Rufen Sie Vorfälle für eine bestimmte Instanz ab.

Datenform: Code: "InstanceIncidents", Data ist ein Array von Vorfallsobjekten.

uip maestro flow instance asset

Rufen Sie die Flow-Definition (das .flow -Asset) ab, die an das Release dieser Instanz angehängt ist – nützlich beim Debuggen, um das genaue Diagramm anzuzeigen, das die Instanz ausgeführt hat.

Datenform: Code: "InstanceAsset", Data ist die Flow-JSON.

uip maestro flow instance cursors

Aktuelle Cursorpositionen für die Ausführung abrufen – bei welchen Elementen die Instanz angehalten wird.

Datenform: Code: "InstanceCursors", Data listet die aktuellen Cursorpositionen auf.

uip maestro flow instance goto

Verschieben eines Ausführungscursors von einem Element zu einem anderen. Nützlich zur Wiederherstellung einer fehlerhaften Instanz durch Überspringen oder Wiederholen bestimmter Knoten.

Argumente

• <instance-id> (erforderlich)
• <transitions> (erforderlich) – JSON-Array von Übergängen mit jeweils sourceElementId und targetElementId.

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

Die CLI überprüft die JSON-Analysen und jeder Eintrag hat beide IDs, bevor die API aufgerufen wird.

Datenform

Code: "InstanceGoto".

uip maestro flow instance element-executions

Rufen Sie den Ausführungsverlauf pro Element für eine Instanz ab (was lief, wann und mit welchem Ergebnis).

Datenform

Code: "InstanceElementExecutions", Data ist der Ausführungsverlauf pro Element.

Beispiele

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

Siehe auch

• uip maestro flow incident – Lesen Sie Vorfälle, die von einer bestimmten Instanz getrennt sind
• uip maestro flow job – Die Auftragsansicht einer Instanzausführung
• uip maestro flow process – Neue Instanzen starten
• Orchestrator-Aufträge
• Flow-Übersicht