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.

Trabalhos do UIP Insights

Sintaxe e opções para "trabalhos do UiPath Insights", que expõem painéis predefinidos do Insights como comandos filtráveis por intervalo de tempo e pasta.

uip insights jobs os painéis do Insights predefinidos como comandos de CLI. Cada subcomando publica em um ponto de extremidade dedicado do Insights e retorna a resposta bruta no envelope padrão Code/Data . Todos os sete subcomandos compartilham a mesma superfície de filtro (intervalo de tempo, pastas, processos, máquinas).

Resumo​

uip insights jobs <verb> [options]
uip insights jobs <verb> [options]

Verbo​

TextoFinalidade
summaryContagem total de trabalhos, contagem de sucesso, tempo médio de processamento.
completed-timelineTrabalhos concluídos ao longo do tempo, agrupados por estado do terminal.
uncompleted-timelineTrabalhos não concluídos (em execução/pendentes) ao longo do tempo.
top-failuresProcessos com mais falhas de trabalho.
failures-by-reasonFalhas de trabalho agrupadas por motivo da exceção.
process-detailsDetalhamento do trabalho por processo com contagens por estado.
failure-detailsLinhas de falha detalhadas para investigação detalhada.

Filtros compartilhados​

Cada subcomando insights jobs aceita as mesmas opções:

BandeiraDescription
--time-range <minutes>Intervalo de tempo relativo em minutos (por exemplo por 1440 dia, 43200 por 30 dias).
--started-after <epoch-ms>Hora de início absoluta como milissegundos epoch do Unix.
--started-before <epoch-ms>Tempo de término absoluto em milissegundos de época do Unix.
--folder-key <guid>Filtro da chave da pasta (repetível).
--process-name <name>Filtro do nome do processo (repetível).
--machine-name <name>Filtro do nome da máquina (repetível).
--timezone-offset <minutes>Deslocamento de fuso horário do cliente em minutos a partir do UTC.

É necessário um intervalo de tempo: transmita --time-range ou ambos --started-after e --started-before juntos. Fornecer apenas um de --started-after/--started-before é o mesmo que não fornecer nenhum dos dois — o comando falha com A time range is required. e sai de 1. A combinação de --time-range com o par absoluto é válida, mas o backend do Insights é resolvido no intervalo que for mais restrito. Cada outro filtro (--folder-key, --process-name, --machine-name, --timezone-offset) é opcional; --folder-key, --process-name e --machine-name são repetíveis — passe-os várias vezes para incluir vários valores.

Opções inteiras (--time-range, --started-after, --started-before, --timezone-offset) são validadas no momento da análise; um valor não numérico falha rapidamente com uma mensagem nomeando o sinalizador.

resumo dos trabalhos do uip insights​

Contagem total de trabalhos, contagem de sucesso e tempo médio de processamento.

Opções​

Exemplos​

uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'
uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'

Código de resposta: InsightsJobsSummary.

trabalhos do uip insights concluídos-linha do tempo​

Trabalhos concluídos ao longo do tempo, agrupados por estado do trabalho no terminal.

Opções​

Exemplos​

uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000
uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000

Código de resposta: InsightsJobsCompletedTimeline.

trabalhos do uip insights não concluídos-linha do tempo​

Trabalhos não concluídos (em execução/pendentes) ao longo do tempo.

Opções​

Exemplos​

uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01
uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01

Código de resposta: InsightsJobsUncompletedTimeline.

trabalhos do uip insights principais falhas​

Processos com mais falhas na janela do filtro.

Opções​

Exemplos​

uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'
uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'

Código de resposta: InsightsJobsTopFailures.

falhas de trabalhos do uip insights por motivo​

Falhas de trabalho agrupadas por motivo da exceção.

Opções​

Exemplos​

uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'
uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'

Código de resposta: InsightsJobsFailuresByReason.

trabalhos do uip insights detalhes do processo​

Detalhamento do trabalho por processo com contagens por estado.

Opções​

Exemplos​

uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000
uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000

Código de resposta: InsightsJobsProcessDetails.

detalhes da falha dos trabalhos do uip insights​

Linhas de falha detalhadas para investigação detalhada.

Opções​

Exemplos​

uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'
uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'

Código de resposta: InsightsJobsFailureDetails.

Formato dos dados (--output json)​

Todos os comandos retornam o mesmo envelope. O campo carrega a resposta do Insights específica do ponto de Data — a estrutura interna difere por ponto de extremidade, mas o envelope é uniforme.

{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}
{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}
Observação:

A estrutura interna exata de cada variante de resposta é especificada pela API do Insights e não é enumerada aqui. Execute o comando uma vez com --output json em um tenant com dados para ver o esquema que você consumirá e fixe @uipath/cli no CI se você analisar campos específicos.

Comportamento de erro​

  • Autenticação ausente. A CLI emite Failure com Instructions: "Run 'uip login' to authenticate first." e sai de 1.
  • Erros de back-end (4xx/5xx do Insights). Failure com Instructions: "Check your authentication, tenant, and filter parameters." e sai de 1.
  • uip insights — visão geral da ferramenta.
  • uip login — sessão usada para cada chamada do Insights.
  • uip traces — Intervalos de observabilidade do LLM, uma superfície de observabilidade ortogonal.

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