Ausführung des UIP-Agents

uip agent run startet und überwacht Agent-Aufträge in Orchestrator. Intern ruft jeder Unterbefehl die standardmäßigen OData-Endpunkte von Orchestrator-Aufträge/Releases auf – dieselben Endpunkte, die uip or jobs verfügbar macht – in Bezug auf die von uip agent deploy erzeugten Releases.

Jeder Unterbefehl erfordert eine aktive CLI-Sitzung (uip login). Wenn kein --folder-id übergeben wird, verwendet der Befehl den Ordner, der an die aktuelle Sitzung gebunden ist.

Zusammenfassung

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>]

Alle uip agent run -Unterbefehle berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

Ausführungsstart von UIP-Agents

Starten Sie einen Auftrag für ein bereitgestelltes Agent-Release.

Argumente

• <releaseKeyOrName> (erforderlich) – Entweder ein Release-Schlüssel (GUID) oder ein Release-Name. Wenn der Wert keine GUID ist, führt der Befehl eine Namenssuche für den Releases OData-Endpunkt ($filter=Name eq '<name>') durch.

Optionen

Markieren	Standard	Zweck
-i, --inputs <json>	{}	Geben Sie Argumente als JSON-Zeichenfolge ein. Muss ein gültiges JSON-Format haben.
--folder-id <id>	Anmeldeordner	ID der Organisationseinheit des Orchestrator-Ordners. Gesendet als X-UIPATH-OrganizationUnitId.
-t, --tenant <tenant>	Mandanten anzumelden	Zielmandant.
--login-validity <minutes>	10	Mindestlaufzeit des Tokens in Minuten erforderlich.

Beispiele

# 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

Datenform (--output json)

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

JobId ist die numerische ID, die Sie an uip agent run status übergeben. JobKey ist das GUID-Äquivalent, das für Vergleiche mit der Orchestrator-Benutzeroberfläche oder uip or jobs -Befehlen nützlich ist. Aufträge werden mit Strategy: ModernJobsCount und JobsCount: 1 gestartet.

Ausführungsstatus von UIP-Agents

Rufen Sie den aktuellen Status eines einzelnen Auftrags ab.

Argumente

• <jobId> (erforderlich) – Numerische Orchestrator-Auftrags-ID (von run start oder uip or jobs list).

Optionen

Wie run start (--folder-id, -t/--tenant, --login-validity).

Beispiele

# Quick status check
uip agent run status 12345

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

Datenform (--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 Werte spiegeln die Auftragsstatus von Orchestrator wider (Pending, Running, Successful, Faulted, Stopped, Suspended, …).
• Info ist nur vorhanden, wenn der Auftrag eine Statusmeldung hat (normalerweise bei einem Fehler).
• Output wird OutputArguments als JSON-Objekt geparst. Wenn die Analyse fehlschlägt, wird stattdessen die Rohzeichenfolge zurückgegeben.

Ausführungsliste des UIP-Agents

Listen Sie die in einem Ordner verfügbaren Agent-Releases auf.

Argumente

Keine.

Optionen

Markieren	Standard	Zweck
--folder-id <id>	Anmeldeordner	ID der Organisationseinheit des Orchestrator-Ordners.
--filter <odata>	–	Zusätzlicher OData-Ausdruck $filter an die Standardabfrage angehängt (die bereits nach Name sortiert wird).
-t, --tenant <tenant>	Mandanten anzumelden	Zielmandant.
--login-validity <minutes>	10	Mindestlaufzeit des Tokens in Minuten erforderlich.

Beispiele

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

Datenform (--output json)

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

Ein leerer Ordner gibt einen Message -Protokolleintrag (No releases found in this folder. Publish an agent first.) und keine Erfolgsnutzlast zurück.

Zugehörig

• uip agent deploy – Veröffentlicht die Releases, die run list auflistet.
• uip agent eval run start – Das Auswertungsäquivalent von run start, das auf den Agent Runtime-Dienst und nicht auf einen Orchestrator-Auftrag abzielt.
• Orchestrator: Aufträge – die vollständige Auftrags-API (Beenden, Neustarten, Protokolle, Anhänge).

Siehe auch

• Authentifizierung – Sitzungen, Mandanten und --login-validity.
• Globale Optionen, Exitcodes.