UiPath Documentation
uipath-cli
latest
false
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Guide de l'utilisateur de UiPath CLI

tâche de flux uip

uip flow job inspecte une tâche de flux individuelle - une tentative d'exécution d'une instance de processus) en streaming ses traces ou en récupérant son statut détaillé.

Toutes les sous-commandes nécessitent uip login et respectent les options globales. Les codes de sortie suivent le contrat standard.

Synthèse

uip flow job traces <job-key>
                    [-t, --tenant <name>] [--poll-interval <ms>]
                    [--traces-service <name>] [--pretty]
                    [--login-validity <minutes>]

uip flow job status <job-key>
                    [-t, --tenant <name>] [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]
uip flow job traces <job-key>
                    [-t, --tenant <name>] [--poll-interval <ms>]
                    [--traces-service <name>] [--pretty]
                    [--login-validity <minutes>]

uip flow job status <job-key>
                    [-t, --tenant <name>] [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]

traçages de tâche de flux uip

Flux les événements de Trace de l’exécution pour une tâche en cours d’exécution ou récemment terminée. Les lignes sont transmises à stderr au fur et à mesure qu'elles arrivent; l'état final et la durée sont également diffusés.

Arguments

  • <job-key> (obligatoire) : clé de tâche (GUID de process run).

Options

OptionDefaultDescription
-t, --tenant <name>locataire authentifiéNom du locataire.
--poll-interval <ms>2000Intervalle d'interrogation. Doit être un nombre positif.
--traces-service <name>llmopstenant_Nom du service de traçage (Avancé; remplacement uniquement lorsqu'il est indiqué).
--prettydésactivéÉvénements de traçage. Sans cela, chaque événement est émis sous forme de une seule ligne JSON — convivial pour les pipelines dans jq.
--login-validity <minutes>10Seuil d’actualisation du jeton.

Comportement

  • Écrit une ligne d'en-tête dans stderr: Streaming traces for job: <key> Polling every Ns...
  • Flux chaque événement de traçage via ScreenLogger.progress .
  • À la fin, génère Job <key>: <finalState> (<durationMs>ms).
  • Code de sortie: 0 si la tâche a réussi, 1 dans le cas contraire (par result.success).

Exemples

# Raw JSON lines — best for piping
uip flow job traces b2c3d4e5-| jq -c 'select(.level=="error")'

# Human-readable
uip flow job traces b2c3d4e5---pretty

# Slower polling for quiet jobs
uip flow job traces b2c3d4e5---poll-interval 5000
# Raw JSON lines — best for piping
uip flow job traces b2c3d4e5-… | jq -c 'select(.level=="error")'

# Human-readable
uip flow job traces b2c3d4e5-… --pretty

# Slower polling for quiet jobs
uip flow job traces b2c3d4e5-… --poll-interval 5000

Sortie: les traçages sont diffusés directement — aucune charge utile Data finale.

statut de la tâche du flux uip

Obtenez le statut d'une tâche de flux. Renvoie un résumé sélectionné de 14 champs par défaut; --detailed renvoie la réponse complète d'Orchestrator.

Arguments

  • <job-key> (obligatoire) — clé de tâche.

Options

OptionDefaultDescription
-t, --tenant <name>locataire authentifiéNom du locataire.
--folder-key <key>dossier authentifiéClé de dossier.
--detaileddésactivéRenvoyez la réponse complète au lieu du résumé dans les 14 champs.
--login-validity <minutes>10Seuil d’actualisation du jeton.

Data shape (default summary)

{
  "Code": "FlowJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "Flow",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceFlow",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}
{
  "Code": "FlowJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "Flow",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceFlow",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}

Avec --detailed, Data est l'objet de tâche Orchestrator complet (tous les champs, non aplatis).

Remarque :

La forme de la réponse détaillée complète est ce que renvoie Orchestrator et n'est pas strictement saisie par la CLI. La présence des champs peut varier d'une version d'Orchestrator à l'autre — pour les scripts qui analysent des champs spécifiques, interrogez de manière défensive et épinglez @uipath/cli dans CI.

Exemples

# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "<folder-key>" \
           --inputs '{}' --output-filter "jobKey" --output plain)
uip flow job traces "$JOB_KEY" --pretty

# Get the summary once the job is done
uip flow job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip flow job status "$JOB_KEY" --detailed
# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "<folder-key>" \
           --inputs '{}' --output-filter "jobKey" --output plain)
uip flow job traces "$JOB_KEY" --pretty

# Get the summary once the job is done
uip flow job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip flow job status "$JOB_KEY" --detailed

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour