UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

UIP AOPS パイプライン

「uip aops pipeline」および「uip aops execution」の構文とオプション。CICD パイプラインを管理し、その実行を検査または制御します。

uip aops pipeline は、CI/CD パイプライン (一覧表示、取得、作成、更新、実行、削除) を管理します。uip aops execution は、1 つのパイプライン実行 (メタデータの取得、ログのストリーム、ジョブの詳細の取得、または停止) を検査および制御します。どちらも、「 接続」/「プロジェクト 」ページのソース管理コマンドとは別の識別子名前空間である CICD サービスを呼び出します。共通の概念については、「 uip aops の概要 」をご覧ください。

注:

pipeline update <id> --file は完全置換 (HTTP PUT セマンティクス) であり、pipeline get が既定で返すPipelineDtoではなく、EditPipelineDto形状を予期します。pipeline get <id> > p.json直接update --file p.jsonにパイプで接続するのではなく、代わりに pipeline get <id> --for-update --output-file <path> を使用して、すでに変換済みの図形を書き込みます。

概要​

uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]
uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]

UIP AOPS パイプラインのリスト​

アクティブなランタイム環境に表示されるパイプラインのリストを表示します (StudioAdmin の UI で設定します。予期した内容が表示されない場合は、そこでテナント/フォルダーを切り替えます)。

オプション​

長押し値 (Value)説明
--repository-ids <csv>コンマ区切りSC リポジトリの UUID を 1 つ以上に絞り込みます ( connection reposから)。
--offset <n>integerスキップする番号。の倍数である必要があります--limit既定 0です。
--limit <n>integer返される最大値。既定 20です。
--search <term>stringパイプライン名に対するサーバー側の部分文字列フィルター。

データシェイプ(--output json)​

{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}
{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}

パイプラインごとにキュレーションされた行 — ブランチやプロジェクトのバインドなど、完全な DTO には pipeline get <id> を使用します。

UIP AOPS パイプラインのステート​

パイプラインのステート (StudioAdmin ダッシュボードで使用されるカウントとロールアップ状態) のランタイム環境全体のスナップショットを取得します。リストを作成したり変更したりする前に、ランタイム環境にアクセスできることを確認するための安価な方法。

データシェイプ(--output json)​

{ "Code": "PipelinesState", "Data": {} }
{ "Code": "PipelinesState", "Data": {} }

UIP AOPS パイプライン プロセス​

パイプラインをバインドできるオートメーション プロセスを一覧表示します。

データシェイプ(--output json)​

{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}
{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}

プロセスごとにキュレーションされた行 — 返された ProcessId は、パイプラインの作成時に PipelineDtoの processIdentifier として使用します。引数を含む完全な DTO の pipeline process <process-id> を使用して 1 つにドリルダウンします。

UIP AOPS パイプライン プロセス​

単一のオートメーション プロセスを識別子で解決します。

引数​

名前Required目的
<process-id>○pipeline processesのプロセス識別子です。

データシェイプ(--output json)​

{ "Code": "PipelineProcess", "Data": {} }
{ "Code": "PipelineProcess", "Data": {} }

UIP AOPS パイプライン リポジトリ​

少なくとも 1 つのパイプラインを持つ SourceControl リポジトリを一覧表示します。

データシェイプ(--output json)​

{ "Code": "PipelineRepos", "Data": [] }
{ "Code": "PipelineRepos", "Data": [] }

UIP AOPS パイプライン Get​

識別子でパイプラインを取得します。

引数​

名前Required目的
<pipeline-id>○pipeline listのパイプライン識別子です。

オプション​

長押し値 (Value)説明
--for-updateフラグサーバー専用のフィールドを削除して完全なPipelineDtoではなくEditPipelineDto図形を返します。手動変換なしで結果を pipeline update --file に直接フィードします。
--output-file <path>パスまた、ペイロードを JSON (UTF-8、2 スペースのインデント) としてこのファイルに書き込みます。Stdout は、完全な構造化エンベロープを引き続き出力します。

--for-update DTO 独自のキーの大文字と小文字を Data に保持します (パスカル大文字と小文字ではありません)。--output-filter は、印刷された Data に対して実行され、大文字と小文字が区別されます。 --for-updateを指定すると、DTO の独自のフィールド名と一致します。

uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json
uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json

データシェイプ(--output json)​

{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }
{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }

パイプラインを名前で検索する。

オプション​

長押し値 (Value)説明
--name <name>string完全一致ルックアップ。単一の PipelineDtoを返します。
--prefix <prefix>stringStartsクエリで始まる。配列を返します。

--name/--prefixの 1 つのみが必要です。両方を渡すか、両方を渡すか、両方を渡さないと、ネットワーク呼び出しの前にクライアント側で失敗します。

uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"
uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"

データシェイプ(--output json)​

{ "Code": "PipelineSearch", "Data": {} }
{ "Code": "PipelineSearch", "Data": {} }

一致は、空の成功ではなく、 Pipeline '<name>' not found. ( --nameの場合) または No pipelines matched prefix '<prefix>'. ( --prefixの場合) で失敗しません。

UIP AOPS パイプラインの作成​

JSON ファイルから PipelineDtoに準拠した新しいパイプラインを作成します。

オプション​

長押し値 (Value)Required説明
--file <path>パス○作成する PipelineDto を含む JSON ファイルです。サーバーによって割り当てられた identifierは含めないでください。
--telemetry-flow-id <id>string×サーバー側の関連付け用のテレメトリ フロー ID。

データシェイプ(--output json)​

{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }

返された identifier をキャプチャして、フォローアップの run/update/delete 呼び出しに使用します。競合エラーは通常、同じ名前のパイプラインがすでに存在することを意味します。

UIP AOPS パイプラインの更新​

既存のパイプラインを更新します。完全置換 (HTTP PUT) — ファイルで省略されたフィールドはすべてサーバー側でクリアされます。

引数​

名前Required目的
<pipeline-id>○更新するパイプライン。ファイルの identifier フィールドが設定されている場合は、そのフィールドと一致する必要があります。

オプション​

長押し値 (Value)Required説明
--file <path>パス○適用する EditPipelineDto を含む JSON ファイルです。

EditPipelineDto自身のキーのみが送信されます — 認識できないキーを含むファイル (単に大文字と小文字が間違っているファイルを含む) は、部分ワイプとしてサイレントに削除されるのではなく、完全に拒否されます。

データシェイプ(--output json)​

{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }
{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }

Data.Pipeline は、ディスクから読み取られたファイルではなく、送信された要求をエコーします。

UIP AOPS パイプラインの削除​

識別子でパイプラインを削除します。永続的 — 実行中の実行は自動的には停止されませんが、新しい実行は直ちに拒否されます。

引数​

名前Required目的
<pipeline-id>○pipeline listのパイプライン識別子です。

オプション​

長押し説明
-y, --yes必須。この元に戻せない操作を確認します。

データシェイプ(--output json)​

{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

UIP AOPS パイプラインの実行​

パイプライン実行をトリガーする。すぐに 202 を返します。実行は非同期的にキューに登録されます。

引数​

名前Required目的
<pipeline-id>○pipeline listのパイプライン識別子です。

データシェイプ(--output json)​

{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

pipeline executions <pipeline-id> を使用して新しい実行 ID を検出し、execution logs --follow追跡します。

UIP AOPS パイプラインの保存と実行​

JSON からパイプライン DTO を永続化し、直ちに実行します。

オプション​

長押し値 (Value)Required説明
--file <path>パス○保存して実行する PipelineDto を含む JSON ファイルです。
--telemetry-flow-id <id>string×サーバー側の関連付け用のテレメトリ フロー ID。

データシェイプ(--output json)​

{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}
{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}

executionId は、永続化されたパイプラインの latestPipelineExecution から持ち上げられ、すぐに execution logs --followに連鎖します。フィールドがない場合は null です。

UIP AOPS パイプラインの実行​

パイプラインの実行のリストを表示します。

引数​

名前Required目的
<pipeline-id>○pipeline listのパイプライン識別子です。

オプション​

長押し値 (Value)説明
--offset <n>integerスキップする番号。の倍数である必要があります--limit既定 0です。
--limit <n>integer返される最大値。既定 20です。

データシェイプ(--output json)​

{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}
{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}

完全な DTO (実行モード、トリガー ユーザー、jobExecutionIdentifier、エラー コード) のexecution get <execution-id>を使用して 1 つにドリルダウンします。

UIP AOPS パイプラインの実行 - 一括​

複数のパイプライン実行のメタデータを 1 回の往復で取得します。

オプション​

長押し値 (Value)Required説明
--ids <csv>コンマ区切り○パイプライン 実行 識別子 ( pipeline executionsから) であり、パイプライン ID ではありません。

データシェイプ(--output json)​

{ "Code": "PipelineExecutionsBulk", "Data": [] }
{ "Code": "PipelineExecutionsBulk", "Data": [] }

UIP の AOPS の実行​

パイプラインの実行を検査および制御する。getを除くすべての動詞は、<execution-id>位置 (CLI が基になるjobKeyを検索する) を受け入れるか、すでにそのルックアップがある場合はそのルックアップをスキップするように--job-key <key>します。get は、実行 ID のみによってキーに設定されます。

UIP AOPS 実行 Get​

パイプライン実行のメタデータを実行 ID で取得する

引数​
名前Required目的
<execution-id>○pipeline executions <pipeline-id>から
オプション​
長押し説明
--with-argumentsまた、パイプラインの実行に使用したランタイム入力引数 (解析済みの JSON、または解析に失敗した場合は生の文字列) も取得します。往復1回追加。
データシェイプ(--output json)​
{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }
{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }

返されたjobExecutionIdentifierをlogs/details/stopの--job-keyとして使用し、自動検索をスキップします。

UIP AOPS 実行ログ​

実行のログを取得します。

引数​
名前Required目的
[execution-id]条件付き--job-keyが設定されていない限り必須です。--follow が設定されているかどうかに関係なく必須です (ステート ポーリングは execution-id キーです)。
オプション​
長押し値 (Value)説明
--job-key <key>string実行 ID の検索をスキップして、このジョブ キーを直接使用します。
--followフラグ実行が最終ステート (Successful/Faulted/Stopped) に達するまでログを記録します。
--limit <n>integerログの取得あたりのページ サイズ。既定 200です。
--poll-interval <ms>integer--followが設定されている場合のポーリングの間隔。既定 2000です。
--timeout <ms>integer諦めるまでのフォローの最大時間。既定の 1800000 (30 分)。

--followなし: 現在のログ スライスを出力して終了します (Code: "ExecutionLogs")。--followを使用すると、ログ行は到着時に stderr にストリーミングされ (--log-levelの対象ではなく、--log-file によってキャプチャされません — それらを保持するには stderr を明示的にリダイレクトします)、stdout は終了状態と行数 (Code: "ExecutionLogsFollowed") を含む最終エンベロープを出力します。

uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log
uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log
データシェイプ(--output json)​
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }

UIP AOPS の実行の詳細​

基になるジョブ実行の詳細ドキュメント (ロボット、マシン、リリース、ホスト コンテキスト) を取得します。失敗をトリアージして、失敗が実行されたランナーを確認する場合に便利です。

引数​
名前Required目的
[execution-id]条件付き--job-keyが設定されていない限り必須です。
オプション​
長押し値 (Value)説明
--job-key <key>string実行 ID の検索をスキップして、このジョブ キーを直接使用します。
データシェイプ(--output json)​
{ "Code": "ExecutionDetails", "Data": {} }
{ "Code": "ExecutionDetails", "Data": {} }

UIP AOPS の実行停止​

パイプライン実行の停止をリクエストします。べき等 — すでに終了した実行で呼び出すと、エラーなしで現在のステートが返されます。

引数​
名前Required目的
[execution-id]条件付き--job-keyが設定されていない限り必須です。--wait が設定されているかどうかに関係なく必須です。
オプション​
長押し値 (Value)説明
--job-key <key>string実行 ID の検索をスキップして、このジョブ キーを直接使用します。
--waitフラグ実行がすぐに戻るのではなく、ターミナルに落ち着くまでポーリングします。
--poll-interval <ms>integer--waitが設定されている場合のポーリングの間隔。既定 2000です。
--timeout <ms>integer[ --wait ] を設定した場合の待機の最大時間です。既定 300000 (5 分)。
uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait
uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait
データシェイプ(--output json)​
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }

--waitを使用すると、最終的なエンベロープは決済されたstateでCode: "ExecutionStopped"されます。すでに終了している実行で stop を呼び出すと、停止を再発行する代わりに Code: "ExecutionAlreadyTerminal" が返されます。

  • uip aops — 概要と概念
  • connections — パイプラインの構築元のリポジトリを検索します。
  • projects — パイプラインがバインドされているプロセスを検出します。

参照​

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得