- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- UiPath for Coding Agents
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- uip docsai
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- list-workflow-examples
- パッケージ化
- 元に戻す
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- UIA
- UIP トレース
- 移行
- 参照とサポート
UiPath CLI ユーザー ガイド
uip maestro instance は、個々の プロセス インスタンス (パブリッシュされた Maestro プロセスの 1 回の実行) を検査してステアリングします。サイドバーのエントリに instancesと表示されていても、コマンド名は単数形(instance)です。
すべてのサブコマンドには uip login が必要であり、 グローバルオプションが適用されます。終了コードは 標準コントラクトに従います。
概要
uip maestro instance list -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get <instance-id> -f <folder-key>
uip maestro instance pause <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance resume <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance cancel <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance retry <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance migrate <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables <instance-id> -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents <instance-id> -f <folder-key>
uip maestro instance asset <instance-id> -f <folder-key>
uip maestro instance cursors <instance-id> -f <folder-key>
uip maestro instance goto <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions <instance-id> -f <folder-key>
uip maestro instance list -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get <instance-id> -f <folder-key>
uip maestro instance pause <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance resume <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance cancel <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance retry <instance-id> -f <folder-key> [--comment <text>]
uip maestro instance migrate <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables <instance-id> -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents <instance-id> -f <folder-key>
uip maestro instance asset <instance-id> -f <folder-key>
uip maestro instance cursors <instance-id> -f <folder-key>
uip maestro instance goto <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions <instance-id> -f <folder-key>
-f, --folder-key <key>は、すべてのサブコマンドで必要です。
共通オプション
-f, --folder-key <key>(必須) — フォルダー キー (GUID)。--comment <text>(操作コマンドのみ) — 操作で記録されたオプションのコメント。省略すると空の文字列として送信されます。
サブコマンド
UIP Maestro インスタンスのリスト
フォルダー内のインスタンスのリストを取得します。スコープは processType=ProcessOrchestrationです。
オプション
| オプション | 既定 (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 is an array of process-instance objects.
uip maestro instance 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 インスタンスのインシデント
データ形状: Code: "InstanceIncidents"、 Data はインシデントオブジェクトの配列です。
UIP Maestro インスタンス アセット
このインスタンスのリリースに添付された BPMN アセットを取得します。
データシェイプ: Code: "InstanceAsset"、 Data は BPMN アセットペイロードです。
UIP Maestro インスタンスのカーソル
現在の実行カーソル位置 (インスタンスが一時停止している要素) を取得する。
データシェイプ: Code: "InstanceCursors"、現在のカーソル位置を一覧表示 Data 。
UIP Maestro インスタンス Goto
実行カーソルをある要素から別の要素に移動します。
引数
<instance-id>(必須)<transitions>(必須) — それぞれにsourceElementIdとtargetElementIdを持つトランジションの JSON 配列です。
uip maestro instance goto c3d4e5f6-… \
'[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
--folder-key c3d4e5f6-…
uip maestro instance goto c3d4e5f6-… \
'[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
--folder-key c3d4e5f6-…
データシェイプ
Code: "InstanceGoto" です。
UIP Maestro instance element-executions
インスタンスの要素ごとの実行履歴を取得します。
データシェイプ
Code: "InstanceElementExecutions", Data is the per-element execution history.
例
# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
--process-key "InvoiceOrchestration:1.0.0" --limit 50
# Pause, fix, resume
uip maestro instance pause <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>
# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry <id> --folder-key <k>
# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
--process-key "InvoiceOrchestration:1.0.0" --limit 50
# Pause, fix, resume
uip maestro instance pause <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>
# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry <id> --folder-key <k>
# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
参照
uip maestro incidents— 特定のインスタンスから切り離されたインシデントuip maestro job— インスタンス実行のジョブビューuip maestro process— 新しいインスタンスを開始する- Orchestrator のジョブ
- Maestro の概要
- 概要
- 共通オプション
- サブコマンド
- UIP Maestro インスタンスのリスト
- uip maestro instance get
- UIP Maestro インスタンスの一時停止
- UIP Maestro インスタンスの再開
- uip Maestro インスタンスのキャンセル
- UIP Maestro インスタンスのリトライ
- uip maestro インスタンスの移行
- UIP Maestro インスタンス変数
- UIP Maestro インスタンスのインシデント
- UIP Maestro インスタンス アセット
- UIP Maestro インスタンスのカーソル
- UIP Maestro インスタンス Goto
- UIP Maestro instance element-executions
- 例
- 参照