uip insights jobs

「uip insights jobs」の構文とオプション - プリセットされた Insights ダッシュボードを、時間範囲とフォルダーでフィルター処理可能なコマンドとして公開します。

uip insights jobs では、事前設定された Insights ダッシュボードが CLI コマンドとして公開されます。すべてのサブコマンドは専用の Insights エンドポイントに投稿し、標準の Code/Data エンベロープで生の応答を返します。7 つのサブコマンドはすべて、同じフィルター サーフェス (時間範囲、フォルダー、プロセス、マシン) を共有します。

概要

uip insights jobs <verb> [options]

動詞

動詞	目的
summary	ジョブの合計数、成功数、平均処理時間
completed-timeline	完了したジョブの経時的推移です。終了ステート別にグループ化されています。
uncompleted-timeline	未完了 (実行中/保留中) のジョブの経時的推移
top-failures	ジョブの失敗が最も多いプロセス。
failures-by-reason	ジョブの失敗を例外の理由別にグループ化します。
process-details	プロセスごとのジョブの内訳とステート別のカウント。
failure-details	ドリルダウン調査のための詳細な失敗行。

共有フィルター

すべての insights jobs サブコマンドは、同じオプションを受け入れます。

フラグ	説明
--time-range <minutes>	相対的な時間範囲 (分) (例:1440 1 日、 43200 30 日)。
--started-after <epoch-ms>	絶対開始時刻 (Unix エポックのミリ秒) です。
--started-before <epoch-ms>	終了時間の絶対時間 (Unix エポックのミリ秒) です。
--folder-key <guid>	フォルダー キー フィルター (繰り返し可能)。
--process-name <name>	プロセス名フィルター (反復可能)。
--machine-name <name>	マシン名フィルター (反復可能)。
--timezone-offset <minutes>	UTC からの分単位のオフセット (クライアントのタイムゾーン)。

時間範囲が必要です。渡すには、 --time-range渡すか、--started-afterと --started-before の両方を同時に渡します。--started-after/--started-before のいずれか 1 つだけを指定することは、どちらも指定しないことと同じです。コマンドは A time range is required. で失敗し、1終了します。--time-rangeを絶対ペアと組み合わせても有効ですが、Insights のバックエンドは、いずれか狭い方の間隔に解決されます。その他のフィルター (--folder-key、 --process-name、 --machine-name、 --timezone-offset) はすべて任意です。 --folder-key、 --process-name、 --machine-name は繰り返し可能です。複数回渡すと複数の値が含まれます。

整数オプション (--time-range、 --started-after、 --started-before、 --timezone-offset) は解析時に検証されます。数値以外の値は、フラグに名前を付けるメッセージが表示され、すぐに失敗します。

uip insights jobs summary

ジョブの合計数、成功数、平均処理時間。

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'

応答コード: InsightsJobsSummary

uip insights jobs completed-timeline

完了したジョブの経時的推移です。ターミナル ジョブのステート別にグループ化されています。

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000

応答コード: InsightsJobsCompletedTimeline

uip insights jobs uncompleted-timeline

未完了 (実行中/保留中) のジョブの経時的推移

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01

応答コード: InsightsJobsUncompletedTimeline

uip insights jobs top-failures

[フィルター] ウィンドウで失敗が最も多いプロセス。

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'

応答コード: InsightsJobsTopFailures

uip insights jobs failures-by-reason

ジョブの失敗を例外の理由別にグループ化します。

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'

応答コード: InsightsJobsFailuresByReason

uip insights jobs process-details

プロセスごとのジョブの内訳とステート別のカウント。

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000

応答コード: InsightsJobsProcessDetails

uip insights jobs failure-details

ドリルダウン調査のための詳細な失敗行。

オプション

詳しくは、「 共有フィルター」をご覧ください。

例

uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'

応答コード: InsightsJobsFailureDetails

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

すべてのコマンドは同じエンベロープを返します。Data フィールドには、エンドポイント固有の Insights 応答が含まれます。内部構造はエンドポイントごとに異なりますが、エンベロープは均一です。

{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}

注:

各応答バリアントの正確な内部構造は Insights API によって指定されるため、ここでは列挙しません。データがあるテナントに対して --output json でコマンドを 1 回実行して使用するスキーマを確認し、特定のフィールドを解析する場合は CI に @uipath/cli ピン留めします。

エラー動作

• 認証がありません。CLI は Instructions: "Run 'uip login' to authenticate first." を使用してFailureを出力し、1を終了します。
• バックエンド エラー (Insights からの 4xx/5xx)。Instructions: "Check your authentication, tenant, and filter parameters."でFailureし、1を終了します。

関連

• uip insights — ツールの概要。
• uip login — Insights のすべての呼び出しに使用されるセッションです。
• uip traces — LLM Observability spans、直交する可観測性曲面。

参照

• グローバル オプション
• 終了コード