UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Trabalho de fluxo do uip Maestro

Sintaxe e opções para o "uip Maestro Flow Job", que transmite traces de execução e busca o status detalhado para trabalhos de fluxo individuais.

uip maestro flow job inspeciona um trabalho de fluxo individual — uma tentativa de execução de uma instância de processo — transmitindo seus rastreamentos ou buscando seu status detalhado.

Todos os subcomandos exigem uip login e honram as opções globais. Os códigos de saída seguem o contrato padrão.

Resumo​

uip maestro flow job list  [--folder-key <key>] [--state <state>] [--process-name <name>]
                    [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
                    [--login-validity <minutes>]

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

uip maestro flow job status <job-key>
                    [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]
uip maestro flow job list  [--folder-key <key>] [--state <state>] [--process-name <name>]
                    [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
                    [--login-validity <minutes>]

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

uip maestro flow job status <job-key>
                    [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]

lista de trabalhos do fluxo do uip Maestro​

Lista os trabalhos de fluxo em uma pasta.

Opções​

OpçãoPadrãoDescription
--folder-key <key>pasta autenticadaChave da pasta (GUID).
--state <state>—Filtrar por estado do trabalho: Pending, Running, Successful, Faulted, Stopped, Stopping, Suspended, Resumed, Terminating.
--process-name <name>—Filtrar por Nome do processo de fluxo (contém correspondência).
-l, --limit <n>50Número de itens a serem retornados.
--offset <n>0Número de itens a serem ignorados.
--sort-by <field>padrão do servidorClassificar resultados por campo, por exemplo 'Id desc').
--all-fieldsdesativadaRetorna todos os campos da resposta da API em vez de um resumo selecionado.
--login-validity <minutes>10Limite de atualização do token.

Exemplo​

uip maestro flow job list --folder-key c3d4e5f6-… --limit 2
uip maestro flow job list --folder-key c3d4e5f6-… --limit 2

Formato dos dados (resumo padrão)​

{
  "Code": "FlowJobList",
  "Data": [
    {
      "key": "b2c3d4e5-…",
      "state": "Successful",
      "processName": "InvoiceFlow",
      "source": "Manual",
      "startTime": "2025-04-15T10:30:00Z",
      "endTime": "2025-04-15T10:32:11Z"
    }
  ]
}
{
  "Code": "FlowJobList",
  "Data": [
    {
      "key": "b2c3d4e5-…",
      "state": "Successful",
      "processName": "InvoiceFlow",
      "source": "Manual",
      "startTime": "2025-04-15T10:30:00Z",
      "endTime": "2025-04-15T10:32:11Z"
    }
  ]
}

--all-fieldsCom, cada item carrega o objeto de trabalho completo do Orchestrator em vez desse resumo selecionado.

rastreamentos de trabalho do fluxo do UIP Maestro​

Eventos de trace de execução de transmissão para um trabalho em execução ou concluído recentemente. As linhas são transmitidas para stderr conforme elas chegam; o estado final e a duração também são transmitidos.

Argumentos​

  • <job-key> (necessário) — chave do trabalho (GUID de process run).

Opções​

OpçãoPadrãoDescription
--poll-interval <ms>2000Intervalo de pesquisa. Deve ser um número positivo.
--traces-service <name>llmopstenant_Nome do serviço de traces (avançado; substituído apenas quando orientado).
--prettydesativadaEventos de trace de impressão virtual. Sem ele, cada evento é emitido como uma única linha JSON — adequada para canalizar em jq.
--login-validity <minutes>10Limite de atualização do token.

Comportamento​

  • Grava uma linha de cabeçalho no stderr: Streaming traces for job: <key> Polling every Ns...
  • Transmite cada evento de trace por meio de ScreenLogger.progress (stderr).
  • Na conclusão, emite Job <key>: <finalState> (<durationMs>ms).
  • Código de saída: 0 se o trabalho foi bem-sucedido, 1 caso contrário (por result.success).

Exemplos​

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

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

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

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

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

Saída: os traces são transmitidos diretamente — sem carga Data .

status do trabalho do fluxo do Maestro do uip​

Obtenha o status de um trabalho de fluxo. Retorna um resumo de 14 campos selecionado por padrão; --detailed retorna a resposta completa do Orchestrator.

Argumentos​

  • <job-key> necessário) — chave do trabalho (GUID).

Opções​

OpçãoPadrãoDescription
--folder-key <key>pasta autenticadaChave da pasta (GUID).
--detaileddesativadaRetornar a resposta completa em vez do resumo de 14 campos.
--login-validity <minutes>10Limite de atualização do token.

Formato dos dados (resumo padrão)​

{
  "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": "…"
  }
}

Com --detailed, Data é o objeto de trabalho completo do Orchestrator (todos os campos, não mesclados).

Observação:

A forma de resposta detalhada completa é a que o Orchestrator retorna e não é estritamente digitada pela CLI. A presença do campo pode derivar entre versões do Orchestrator — para scripts que analisam campos específicos, consulte defensivamente e fixe @uipath/cli no CI.

Exemplos​

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

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

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

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

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

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades