UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UIP-AOPS-Pipelines

Syntax und Optionen für „uip aops Pipeline“ und „uip aops execution“ die CICD-Pipelines verwalten und ihre Ausführungen überprüfen oder steuern.

uip aops pipeline verwaltet CI/CD-Pipelines – auflisten, abrufen, erstellen, aktualisieren, ausführen, löschen. uip aops execution überprüft und steuert eine Pipelineausführung – ruft Metadaten ab, streamt Protokolle, ruft Auftragsdetails ab oder hält sie an. Beide rufen den CICD-Dienst auf, einen separaten Bezeichner-Namespace aus den SourceControl-Befehlen auf den Verbindungs-/Projektseiten . Gemeinsame Konzepte finden Sie in der uip aops -Übersicht .

Hinweis:

pipeline update <id> --file ist ein vollständiger Ersatz (HTTP PUT-Semantik) und erwartet die Form EditPipelineDto , nicht die Form PipelineDto , die pipeline get standardmäßig zurückgibt. Leiten Sie pipeline get <id> > p.json nicht direkt zu update --file p.json ein – verwenden Sie stattdessen pipeline get <id> --for-update --output-file <path>, wodurch die bereits transformierte Form geschrieben wird.

Zusammenfassung​

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-Pipelineliste​

Listen Sie Pipelines auf, die in der aktiven Runtime-Umgebung sichtbar sind (über die StudioAdmin-Benutzeroberfläche festgelegt – wechseln Sie dort zu den Mandanten/Ordnern, wenn Sie nicht sehen, was Sie erwarten).

Optionen​

LongWertBeschreibung
--repository-ids <csv>durch Kommas getrennt sindAchten Sie auf eine oder mehrere SC-Repository-UUIDs (von connection repos).
--offset <n>IntegerZu überspringende Zahl. Muss ein Mehrfaches von --limit sein. Der Standardwert ist 0.
--limit <n>IntegerZurückzugebendes Maximum. Der Standardwert ist 20.
--search <term>stringServerseitiger Teilzeichenfolgenfilter für den Pipelinenamen.

Datenform (--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" }
  ]
}

Eine kuratierte Zeile pro Pipeline – verwenden Sie pipeline get <id> für das vollständige DTO, einschließlich Verzweigung und Projektbindung.

Status der UIP-Aops-Pipeline​

Rufen Sie einen laufzeitumgebungsweiten Snapshot des Pipelinestatus ab – Anzahl und Rollup-Status, der vom StudioAdmin-Dashboard verwendet wird. Eine kostengünstige Möglichkeit zur Bestätigung, dass die Laufzeitumgebung vor der Auflistung oder Änderung verfügbar ist.

Datenform (--output json)​

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

UIP-Aops-Pipelineprozesse​

Listen Sie Automatisierungsprozesse auf, an die Pipelines gebunden werden können.

Datenform (--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" } ]
}

Eine kuratierte Zeile pro Prozess – verwenden Sie die zurückgegebene ProcessId als processIdentifier von PipelineDto beim Erstellen einer Pipeline. Drilldown mit pipeline process <process-id> für das vollständige DTO einschließlich Argumente.

UIP-Aops-Pipelineprozess​

Lösen Sie einen einzelnen Automatisierungsprozess nach Bezeichner auf.

Argumente​

NameErforderlichZweck
<process-id>jaProzessbezeichner von pipeline processes.

Datenform (--output json)​

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

UIP-Aops-Pipeline-Repositorys​

Listen Sie SourceControl-Repositorys auf, die über mindestens eine Pipeline verfügen.

Datenform (--output json)​

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

UIP-Aops-Pipeline abrufen​

Rufen Sie eine Pipeline nach Bezeichner ab.

Argumente​

NameErforderlichZweck
<pipeline-id>jaPipelinebezeichner von pipeline list.

Optionen​

LongWertBeschreibung
--for-updateMarkierenGeben Sie die EditPipelineDto -Form anstelle der vollständigen PipelineDto zurück, wobei reine Serverfelder entfernt wurden – geben Sie das Ergebnis ohne manuelle Transformation direkt in pipeline update --file ein.
--output-file <path>PfadSchreiben Sie die Nutzlast auch als JSON-Datei (UTF-8, 2-Leerzeichen-Einrückung) in diese Datei. Stdout gibt weiterhin den vollständigen strukturierten Umschlag aus.

--for-update behält die eigene Groß-/Kleinschreibung des DTO-Schlüssels in Data (nicht PascalCased) bei. --output-filter wird für Data als gedruckt ausgeführt und berücksichtigt Groß- und Kleinschreibung – stimmen mit --for-update den eigenen Feldnamen des DTO überein.

Beispiele​

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

Datenform (--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" } }

Suchen Sie eine Pipeline anhand des Namens.

Optionen​

LongWertBeschreibung
--name <name>stringSuche nach exakter Übereinstimmung. Gibt ein einzelnes PipelineDto zurück.
--prefix <prefix>stringBeginnt mit der Abfrage. Gibt ein Array zurück.

Genau eine der Optionen --name/--prefix ist erforderlich – Das Übergeben von beiden oder von keinem von beiden schlägt auf der Clientseite vor einem Netzwerkaufruf fehl.

Beispiele​

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

Datenform (--output json)​

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

Keine Übereinstimmung schlägt mit Pipeline '<name>' not found. (für --name) oder No pipelines matched prefix '<prefix>'. (für --prefix) fehl, anstatt mit einem leeren Erfolg.

UIP-Aops-Pipeline erstellen​

Erstellen Sie eine neue Pipeline aus einer JSON-Datei, die PipelineDto entspricht.

Optionen​

LongWertErforderlichBeschreibung
--file <path>PfadjaJSON-Datei, die das zu erstellende PipelineDto enthält. Fügen Sie keine vom Server zugewiesene identifier hinzu.
--telemetry-flow-id <id>stringneinTelemetrieflow-ID für die serverseitige Korrelation.

Datenform (--output json)​

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

Erfassen Sie die zurückgegebenen identifier für Folgeaufrufe run/update/delete. Ein Konfliktfehler bedeutet in der Regel, dass bereits eine Pipeline mit demselben Namen vorhanden ist.

Aktualisierung der UIP-Aops-Pipeline​

Aktualisieren Sie eine vorhandene Pipeline. Vollständiger Ersatz (HTTP PUT) – jedes Feld, das die Datei weggelassen wird, wird serverseitig gelöscht.

Argumente​

NameErforderlichZweck
<pipeline-id>jaZu aktualisierende Pipeline. Muss mit dem Feld identifier der Datei übereinstimmen, wenn dieses Feld festgelegt ist.

Optionen​

LongWertErforderlichBeschreibung
--file <path>PfadjaJSON-Datei, die das anzuwendende EditPipelineDto enthält.

Nur die eigenen Schlüssel von EditPipelineDto werden gesendet – eine Datei, die einen nicht erkannten Schlüssel enthält (einschließlich eines, der lediglich in einem falschen Paket enthalten ist), wird direkt abgelehnt, anstatt im Hintergrund als teilweise Löschung verworfen zu werden.

Datenform (--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 gibt die gesendete Anforderung wieder, nicht die Datei, die vom Datenträger gelesen wurde.

UIP-Aops-Pipeline löschen​

Löschen Sie eine Pipeline nach Bezeichner. Endgültig – laufende Ausführungen werden nicht automatisch beendet, aber neue Ausführungen werden sofort abgelehnt.

Argumente​

NameErforderlichZweck
<pipeline-id>jaPipelinebezeichner von pipeline list.

Optionen​

LongBeschreibung
-y, --yesErforderlich. Bestätigt diesen Vorgang, wenn er nicht rückgängig gemacht werden kann.

Datenform (--output json)​

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

Ausführung der UIP-Aops-Pipeline​

Lösen Sie eine Pipelineausführung aus. Gibt 202 sofort zurück – die Ausführung wird asynchron in die Warteschlange eingereiht.

Argumente​

NameErforderlichZweck
<pipeline-id>jaPipelinebezeichner von pipeline list.

Datenform (--output json)​

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

Verwenden Sie pipeline executions <pipeline-id>, um die neue Ausführungs-ID zu erkennen, und dann execution logs --follow, um sie nachzuverfolgen.

Speichern und Ausführen der UIP-Aops-Pipeline​

Behalten Sie ein Pipeline-DTO von JSON bei und führen Sie es sofort aus.

Optionen​

LongWertErforderlichBeschreibung
--file <path>PfadjaJSON-Datei, die die zu speichernde und auszuführende PipelineDto enthält.
--telemetry-flow-id <id>stringneinTelemetrieflow-ID für die serverseitige Korrelation.

Datenform (--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 wird aus dem latestPipelineExecution der beibehaltenen Pipeline zur sofortigen Verkettung mit execution logs --follow angehoben; es ist null, wenn das Feld fehlt.

Ausführungen von UIP-Aops-Pipelines​

Listen Sie Ausführungen für eine Pipeline auf.

Argumente​

NameErforderlichZweck
<pipeline-id>jaPipelinebezeichner von pipeline list.

Optionen​

LongWertBeschreibung
--offset <n>IntegerZu überspringende Zahl. Muss ein Mehrfaches von --limit sein. Der Standardwert ist 0.
--limit <n>IntegerZurückzugebendes Maximum. Der Standardwert ist 20.

Datenform (--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" } ]
}

Drilldown mit execution get <execution-id> für das vollständige DTO (Ausführungsmodus, auslösender Benutzer, jobExecutionIdentifier, Fehlercode).

UIP-Aops-Pipelineausführungen – Massenhafte Ausführungen​

Rufen Sie Metadaten für mehrere Pipelineausführungen in einer Runde ab.

Optionen​

LongWertErforderlichBeschreibung
--ids <csv>durch Kommas getrennt sindjaPipeline -Ausführungsbezeichner (von pipeline executions) – keine Pipeline-IDs.

Datenform (--output json)​

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

UIP-Aops-Ausführung​

Inspizieren und steuern Sie Pipeline-Ausführungen. Alle Verben außer get akzeptieren entweder eine <execution-id> -Position (die CLI sucht das zugrunde liegende jobKey für Sie) oder --job-key <key>, um diese Suche zu überspringen, wenn Sie sie bereits haben. get wird nur durch die Ausführungs-ID verschlüsselt.

UIP-Aops-Ausführung abrufen​

Rufen Sie die Metadaten einer Pipelineausführung nach Ausführungs-ID ab.

Argumente​
NameErforderlichZweck
<execution-id>jaVon pipeline executions <pipeline-id>.
Optionen​
LongBeschreibung
--with-argumentsRufen Sie auch die Runtime-Eingabeargumente ab, mit denen die Pipeline ausgeführt wurde (geparste JSON oder die Rohzeichenfolge, wenn die Analyse fehlschlägt). Eine zusätzliche Runde.
Datenform (--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" } } }

Verwenden Sie das zurückgegebene jobExecutionIdentifier als --job-key für logs/details/stop, um die automatische Suche zu überspringen.

UIP-Aops-Ausführungsprotokolle​

Rufen Sie Protokolle für eine Ausführung ab.

Argumente​
NameErforderlichZweck
[execution-id]bedingtErforderlich, es sei denn, --job-key ist festgelegt; erforderlich, unabhängig davon, ob --follow festgelegt ist (die Statusabfrage ist Ausführungs-ID-Schlüssel).
Optionen​
LongWertBeschreibung
--job-key <key>stringVerwenden Sie diesen Auftragsschlüssel direkt und überspringen Sie die Suche nach der Ausführungs-ID.
--followMarkierenStreamen Sie Protokolle, bis die Ausführung einen Endstatus erreicht (Successful/Faulted/Stopped).
--limit <n>IntegerSeitengröße pro Protokollabruf. Der Standardwert ist 200.
--poll-interval <ms>IntegerIntervall zwischen Abfragen, wenn --follow festgelegt ist. Der Standardwert ist 2000.
--timeout <ms>IntegerMaximale Zeit, die Sie einhalten können, bevor Sie aufgeben. Standardmäßig: 1800000 (30 Minuten).

Ohne --follow: Gibt den aktuellen Protokollabschnitt aus und wird beendet (Code: "ExecutionLogs"). Mit --follow: Protokollzeilen werden beim Eintreffen nach zderr gestreamt (vorbehaltlich --log-level, nicht von --log-file erfasst – leiten Sie STDrr explizit um, um sie beizubehalten) und sdout gibt einen endgültigen Umschlag mit dem Endstatus und der Zeilenanzahl aus (Code: "ExecutionLogsFollowed").

Beispiele​
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
Datenform (--output json)​
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }

UIP-Aops-Ausführungsdetails​

Rufen Sie das zugrunde liegende Detaildokument zur Auftragsausführung ab – Roboter, Maschine, Release und Host-Kontext. Nützlich bei der Priorisierung eines Fehlers, um zu sehen, auf welchem Runtime er ausgeführt wurde.

Argumente​
NameErforderlichZweck
[execution-id]bedingtErforderlich, es sei denn, --job-key ist festgelegt.
Optionen​
LongWertBeschreibung
--job-key <key>stringVerwenden Sie diesen Auftragsschlüssel direkt und überspringen Sie die Suche nach der Ausführungs-ID.
Datenform (--output json)​
{ "Code": "ExecutionDetails", "Data": {} }
{ "Code": "ExecutionDetails", "Data": {} }

UIP-Aops-Ausführung angehalten​

Fordern Sie das Anhalten einer Pipelineausführung an. Idempotent – Der Aufruf bei einer bereits beendeten Ausführung gibt den aktuellen Status ohne Fehler zurück.

Argumente​
NameErforderlichZweck
[execution-id]bedingtErforderlich, es sei denn, --job-key ist festgelegt; erforderlich, unabhängig davon, ob --wait festgelegt ist.
Optionen​
LongWertBeschreibung
--job-key <key>stringVerwenden Sie diesen Auftragsschlüssel direkt und überspringen Sie die Suche nach der Ausführungs-ID.
--waitMarkierenAbfragen, bis sich die Ausführung im Terminal befindet, anstatt sofort zurückzukehren.
--poll-interval <ms>IntegerIntervall zwischen Abfragen, wenn --wait festgelegt ist. Der Standardwert ist 2000.
--timeout <ms>IntegerMaximale Wartezeit, wenn --wait festgelegt ist. Standardmäßig: 300000 (5 Minuten).
Beispiele​
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
Datenform (--output json)​
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }

Bei --wait ist der endgültige Umschlag Code: "ExecutionStopped" mit dem festgelegten state. Der Aufruf von stop für eine Ausführung, die bereits beendet ist, gibt Code: "ExecutionAlreadyTerminal" zurück, anstatt den Stopp erneut auszugeben.

  • uip aops – Übersicht und Konzepte.
  • connections – Das Repository erkennen, aus dem eine Pipeline erstellt wird.
  • projects – Erkennen Sie den Prozess, an den eine Pipeline gebunden ist.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben