uip エージェントの実行

uip agent run Orchestrator でエージェントのジョブを開始および監視します。内部的には、各サブコマンドは、標準の Orchestrator ジョブ/リリース OData エンドポイント (uip or jobs が公開するエンドポイントと同じエンドポイント) を呼び出します。このエンドポイントは、uip agent deployによって生成されるリリースにスコープが設定されています。

すべてのサブコマンドには、アクティブなCLIセッション(uip login)が必要です。--folder-id渡さない場合、コマンドは現在のセッションにバインドされたフォルダーを使用します。

概要

uip agent run start <releaseKeyOrName> [-i <json>] [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run status <jobId>                         [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run list                                   [--folder-id <id>] [--filter <odata>] [-t <tenant>] [--login-validity <minutes>]

uip agent runすべてのサブコマンドは、グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を優先します。終了コードは 標準コントラクトに従います。

uip エージェントの実行開始

デプロイ済みのエージェント リリースのジョブを開始します。

引数

• <releaseKeyOrName> (必須) — リリース キー (GUID) またはリリース名のいずれか。値が GUID でない場合、コマンドは Releases OData エンドポイント ($filter=Name eq '<name>') に対して名前検索を実行します。

オプション

フラグ	既定 (Default)	目的
-i, --inputs <json>	{}	引数を JSON 文字列として入力します。有効な JSON である必要があります。
--folder-id <id>	ログイン フォルダー	Orchestrator フォルダーの組織単位 IDX-UIPATH-OrganizationUnitIdとして送信されます。
-t, --tenant <tenant>	テナントにログイン	対象のテナント。
--login-validity <minutes>	10	トークンの有効期間は、最小時間 (分) です。

例

# Start by release key (the exact key from 'agent run list')
uip agent run start a1b2c3d4-0000-0000-0000-000000000401 -i '{"input":"hello"}'

# Start by release name (resolved via OData lookup)
uip agent run start InvoiceAgent -i '{"invoiceUrl":"…"}' --folder-id 42

# Start with no inputs
uip agent run start InvoiceAgent

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

{
  "Code": "AgentJobStarted",
  "Data": {
    "JobId": 12345,
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000410",
    "State": "Pending"
  }
}

JobId は、 uip agent run statusに渡す数値 ID です。JobKey と同等の GUID であり、Orchestrator UI や uip or jobs コマンドに対する相互参照に役立ちます。ジョブは Strategy: ModernJobsCount および JobsCount: 1で開始されます。

UIP エージェントの実行ステータス

1 つのジョブの現在のステートを取得します。

引数

• <jobId> (必須) — 数値の Orchestrator ジョブ ID ( run start または uip or jobs list) です。

オプション

run start (--folder-id, -t/--tenant, --login-validity) と同じです。

例

# Quick status check
uip agent run status 12345

# Explicit folder
uip agent run status 12345 --folder-id 42

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

{
  "Code": "AgentJobStatus",
  "Data": {
    "JobId": 12345,
    "State": "Successful",
    "ReleaseName": "InvoiceAgent",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:31:12Z",
    "Info": "…",
    "Output": { "...": "..." }
  }
}

• State 値は、Orchestrator のジョブのステート (Pending、 Running、 Successful、 Faulted、 Stopped、 Suspended、...) を反映しています。
• Info は、ジョブにステータス メッセージがある場合にのみ存在します (通常は失敗時)。
• Output は JSON として解析 OutputArguments 。解析に失敗した場合は、代わりに生の文字列が返されます。

uip エージェントの実行リスト

フォルダー内の利用可能なエージェントのリリースを一覧表示します。

引数

設定はありません。

オプション

フラグ	既定 (Default)	目的
--folder-id <id>	ログイン フォルダー	Orchestrator フォルダーの組織単位 ID
--filter <odata>	—	既定のクエリに追加された追加の OData $filter 式 (既に Nameで並べ替えられます)。
-t, --tenant <tenant>	テナントにログイン	対象のテナント。
--login-validity <minutes>	10	トークンの有効期間は、最小時間 (分) です。

例

# List all releases in the login folder
uip agent run list

# List in a specific folder
uip agent run list --folder-id 42

# Filter by name prefix
uip agent run list --filter "startswith(Name,'Invoice')"

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

{
  "Code": "AgentReleaseList",
  "Data": [
    {
      "Name": "InvoiceAgent",
      "ReleaseKey": "a1b2c3d4-0000-0000-0000-000000000401",
      "ProcessKey": "InvoiceAgent",
      "Version": "1.0.0",
      "FolderId": 42
    }
  ]
}

フォルダーが空の場合は、 Message ログ エントリ (No releases found in this folder. Publish an agent first.) が返され、成功のペイロードは返されません。

関連

• uip agent deploy — run list列挙したリリースを公開します。
• uip agent eval run start — run startと同等の評価です。対象は Orchestrator のジョブではなく Agent Runtime サービスです。
• Orchestrator: ジョブ — 完全なジョブ API (停止、再起動、ログ、添付ファイル)

参照

• 認証 — セッション、テナント、および --login-validity。
• グローバル オプション、 終了コード。