UIP Maestro フロー インスタンス

「uip Maestro Flow Instance」の構文とオプション。個々のフロー プロセス インスタンスを検査して操作します。

uip maestro flow instance は、個々の プロセス インスタンス (パブリッシュされたフロー プロセスの 1 回の実行) を検査およびステアリングします。サイドバーのエントリに instancesと表示されていても、コマンド名は単数形(instance)です。

すべてのサブコマンドには uip login が必要であり、 グローバルオプションが適用されます。終了コードは 標準コントラクトに従います。

このページは uip maestro bpmn instance と実装を共有します。両方のページに同じ不具合と修正が適用されます。

概要

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>は、すべてのサブコマンドで必要です。

共通オプション

• -f, --folder-key <key> (必須) — フォルダー キー (GUID)。
• --comment <text> (操作コマンドのみ) — 操作で記録されたオプションのコメント。省略すると空の文字列として送信されます。

サブコマンド

UIP Maestro フロー インスタンスのリスト

フォルダー内のインスタンスのリストを取得します。スコープはフロープロセス (processType=Flow) です。

オプション

オプション	既定 (Default)	説明
-l, --limit <n>	DEFAULT_PAGE_SIZE	返すアイテムの数です。1 から 500 で制限されます — インスタンス API はオフセットではなくカーソルによってページングされるため、この CLI の通常の 1 から 10000 の規則よりも厳密です。
--next-page <cursor>	—	前の応答の Pagination.NextPageからのカーソルです。この API は --offset をまったくサポートしていません。ゼロ以外の --offset はすぐに失敗し、代わりに --next-page を使用するように求めるエラーが表示されます。
--process-key <k>	—	プロセス キー (GUID) でフィルター処理するドットで区切られたパッケージ識別子には、 を使用します --package-id。
--package-id <id>	—	パッケージ ID でフィルター処理します。
--error-code <code>	—	エラー コードでフィルター処理します。
--status <status>	—	インスタンスのステータスでフィルター処理する反復可能 (OR セマンティクス)。値: Canceling、 Cancelled、 Completed、 Faulted、 Paused、 Pausing、 Pending、 Resuming、 Retrying、 Running、 Upgrading。
--from-date <iso-8601>	—	このタイムスタンプ以降に開始されたインスタンスのみを含めます。例:2026-01-01T00:00:00Zです。
--to-date <iso-8601>	—	このタイムスタンプ以前に開始されたインスタンスのみを含めます。

データシェイプ

Code: "InstanceList"、 Data はプロセスインスタンスオブジェクトの配列です。

UIP Maestro フロー インスタンスの Get

1 つのインスタンスを ID で取得します。

データ シェイプ: Code: "InstanceGet"、 Data はプロセス インスタンス オブジェクトです。

UIP Maestro フロー インスタンスの一時停止

実行中のインスタンスを一時停止します。データシェイプ: Code: "InstancePaused".

UIP Maestro フロー インスタンスの再開

一時停止したインスタンスを再開します。データシェイプ: Code: "InstanceResumed".

UIP Maestro フロー インスタンスのキャンセル

実行中のインスタンスをキャンセルします。データシェイプ: Code: "InstanceCanceled".

UIP Maestro フロー インスタンスのリトライ

エラーが発生したインスタンスをリトライします。データシェイプ: Code: "InstanceRetried".

UIP Maestro フロー インスタンスの移行

インスタンスを別のパッケージ バージョンに移行します。

引数: <instance-id>、 <new-version> (対象のパッケージ バージョン)。

データシェイプ: Code: "InstanceMigrated".

UIP Maestro フロー インスタンス変数

インスタンスの変数を取得します。

オプション: --parent-element-id <id> — 親要素で変数をフィルタリングします。

データ・シェイプ: Code: "InstanceVariables"、 Data はインスタンス変数ペイロードを運びます。

UIP Maestro フロー インスタンスの変数 - 設定

インスタンスの変数にパッチを適用 (一部更新) します。

オプション

オプション	説明
--inputs <value>	Patch-variables ペイロードは、JSON 文字列、 @file パスとして、または stdin を介してパイプされます。

データシェイプ

Code: "InstanceVariablesSet" です。

UIP Maestro フロー インスタンス variables-all

サブプロセス変数を含む、インスタンスのすべての変数を取得します ( variablesとは異なります。 --parent-element-id 渡されない限り、最上位のプロセスにスコープが設定されます)。

データシェイプ

Code: "InstanceVariablesAll" です。

UIP Maestro フロー インスタンス global-variables

インスタンスのグローバル変数を取得します (プロセス全体で共有され、どの要素にもスコープが設定されません)。

データシェイプ

Code: "InstanceGlobalVariables" です。

UIP Maestro フロー インスタンスの要素のキャンセル

インスタンス全体ではなく、実行中のインスタンス内の特定の要素をキャンセルします。

引数

• <instance-id> (必須)
• <element-id> (必須)

オプション

• --comment <text> — 操作とともに記録される任意のコメントです。

データシェイプ

Code: "ElementCanceled" です。

UIP Maestro フロー インスタンスの要素のリトライ

インスタンス全体をリトライするのではなく、エラーが発生した特定の要素をインスタンス内でリトライします。

引数

• <instance-id> (必須)
• <element-id> (必須)

オプション

• --comment <text> — 操作とともに記録される任意のコメントです。

データシェイプ

Code: "ElementRetried" です。

UIP Maestro フロー インスタンスのメッセージの送信

このフォルダーでリッスンしているワークフロー サブスクリプションにメッセージを送信します。このフォルダーは、外部イベント (プロセスが待機している Webhook ペイロードなど) を実行中のフローに配信するために使用します。

オプション

オプション	説明
-f, --folder-key <key>	(必須) フォルダー キー (GUID)。
--inputs <value>	JSON 文字列、 @file パス、または stdin を介してパイプされるメッセージ ペイロード。

データシェイプ

Code: "MessageSent" です。

UIP Maestro フロー インスタンスのインシデント

特定のインスタンスのインシデントを取得します。

データ形状: Code: "InstanceIncidents"、 Data はインシデントオブジェクトの配列です。

UIP Maestro フロー インスタンスのアセット

このインスタンスのリリースに添付されているフロー定義( .flow アセット)を取得します — デバッグ時にインスタンスが実行した正確なグラフを確認するのに役立ちます。

データシェイプ: Code: "InstanceAsset"、 Data フローJSONです。

UIP Maestro フロー インスタンスのカーソル

現在の実行カーソル位置 (インスタンスが一時停止している要素) を取得する。

データシェイプ: Code: "InstanceCursors"、現在のカーソル位置を一覧表示 Data 。

UIP Maestro フロー インスタンスの [移動]

実行カーソルをある要素から別の要素に移動します。特定のノードをスキップまたはリトライして、エラーが発生したインスタンスを回復する場合に便利です。

引数

• <instance-id> (必須)
• <transitions> (必須) — それぞれに sourceElementId と targetElementIdを持つトランジションの JSON 配列です。

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

CLI は JSON の解析を検証し、各エントリは API を呼び出す前に両方の ID を持ちます。

データシェイプ

Code: "InstanceGoto" です。

UIP Maestro フロー インスタンス element-executions

インスタンスの要素ごとの実行履歴 (何が、いつ、どのような結果で実行されたか) を取得します。

データシェイプ

Code: "InstanceElementExecutions"、 Data 要素ごとの実行履歴です。

例

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

参照

• uip maestro flow incident — 特定のインスタンスから切り離されたインシデントを読み取ります。
• uip maestro flow job — インスタンス実行のジョブビュー
• uip maestro flow process — 新しいインスタンスを開始する
• Orchestrator のジョブ
• フローの概要