UIP フロー インスタンス

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

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

概要

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

共通オプション

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

サブコマンド

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

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

オプション

オプション	既定 (Default)	説明
-l, --limit <n>	DEFAULT_PAGE_SIZE	返すアイテムの数 (1-10000)。
--offset <n>	0	スキップする項目の数 (0 から 1000000)。
--process-key <k>	—	プロセス キーでフィルター処理します。
--package-id <id>	—	パッケージ ID でフィルター処理します。
--error-code <code>	—	エラー コードでフィルター処理します。

データシェイプ

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

UIP フロー インスタンス取得

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

UIP フロー インスタンスの移動先

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

引数

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

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

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

データシェイプ

Code: "InstanceGoto" です。

UIP フローのインスタンスの要素の実行

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

データシェイプ

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

例

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

参照

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