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.

pipelines do uip aops

Sintaxe e opções para "uip aops pipeline" e "uip aops execution", que gerenciam pipelines de CICD e inspecionam ou controlam suas execuções.

uip aops pipeline gerencia pipelines de CI/CD — listar, buscar, criar, atualizar, executar, excluir. uip aops execution inspeciona e controla uma execução do pipeline — buscar metadados, transmitir logs, buscar detalhes do trabalho ou pará-lo. Ambos chamam o serviço CICD, um namespace de identificador separado dos comandos do Controle de origem nas páginas Conexões/projetos . Consulte a visão geraluip aops para conceitos compartilhados.

Observação:

é de substituição completa (semântica HTTP PUTpipeline update <id> --file e espera a forma EditPipelineDto , não a PipelineDto que pipeline get retorna por padrão. Não canalize pipeline get <id> > p.json diretamente em update --file p.json — use pipeline get <id> --for-update --output-file <path> em vez disso, que grava a forma já transformada.

Resumo​

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

lista de pipelines do uip aops​

Liste os pipelines visíveis no ambiente de runtime ativo (definido por meio da interface gráfica do StudioAdmin — alterne os tenants/pastas lá se não vir o que espera).

Opções​

LongValorDescription
--repository-ids <csv>separados por vírgulaLimite para um ou mais UUIDs do repositório SC (de connection repos).
--offset <n>Número inteiroNúmero a ignorar. Deve ser um múltiplo de --limit. Padrão 0.
--limit <n>Número inteiroMáximo a ser retornado. 20Padrão.
--search <term>StringFiltro de substring do lado do servidor no nome do pipeline.

Formato dos dados (--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" }
  ]
}

Uma linha selecionada por pipeline — use pipeline get <id> para o DTO completo, incluindo a ramificação e a associação do projeto.

estado do pipeline do uip aops​

Buscar um instantâneo de todo o ambiente de runtime do estado dos pipelines — contagens e estado de ativação usado pelo painel do StudioAdmin. Uma maneira barato de confirmar se o ambiente de runtime é acessível antes de listar ou mudar.

Formato dos dados (--output json)​

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

processos de pipeline do uip aops​

Lista os processos de automação aos quais os pipelines podem ser associados.

Formato dos dados (--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" } ]
}

Uma linha selecionada por processo — use o ProcessId retornado como o processIdentifier de PipelineDto ao criar um pipeline. Explore um com pipeline process <process-id> para o DTO completo, incluindo argumentos.

processo de pipeline do uip aops​

Resolver um único processo de automação por identificador.

Argumentos​

NameRequiredFinalidade
<process-id>simIdentificador do processo de pipeline processes.

Formato dos dados (--output json)​

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

repositórios de pipeline do uip aops​

Listar repositórios SourceControl que têm pelo menos um pipeline.

Formato dos dados (--output json)​

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

Obtenção de pipeline do uip aops​

Buscar um pipeline por identificador.

Argumentos​

NameRequiredFinalidade
<pipeline-id>simIdentificador do pipeline de pipeline list.

Opções​

LongValorDescription
--for-updateBandeiraRetorne a forma EditPipelineDto em vez da PipelineDto completa, com campos somente servidor removidos — insira o resultado diretamente em pipeline update --file sem transformação manual.
--output-file <path>PathEscreva também a carga útil para esse arquivo como JSON (UTF-8, recuo de 2 espaços). Sdout ainda emite o envelope estruturado completo.

--for-update mantém a caixa do próprio DTO em Data (não em PascalCased). --output-filter é executado em Data como impresso e diferencia maiúsculas de minúsculas — com --for-update, corresponda aos nomes de campos do próprio DTO.

Exemplos​

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

Formato dos dados (--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" } }

Encontrar um pipeline por nome.

Opções​

LongValorDescription
--name <name>StringPesquisa de correspondência exata. Retorna um único PipelineDto.
--prefix <prefix>StringInicia com a consulta. Retorna uma matriz.

Exatamente um de --name/--prefix é necessário — passar ambos, ou nenhum, falha no lado do cliente antes de qualquer chamada de rede.

Exemplos​

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

Formato dos dados (--output json)​

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

Nenhuma correspondência falha com Pipeline '<name>' not found. (para --name) ou No pipelines matched prefix '<prefix>'. (para --prefix) em vez de um sucesso vazio.

criação do pipeline do uip aops​

Crie um novo pipeline a partir de um arquivo JSON em conformidade com PipelineDto.

Opções​

LongValorRequiredDescription
--file <path>PathsimArquivo JSON contendo o PipelineDto a ser criado. Não inclua um identifier atribuído pelo servidor.
--telemetry-flow-id <id>StringnãoID de fluxo de telemetria para correlação no lado do servidor.

Formato dos dados (--output json)​

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

Capture o identifier retornado para as chamadas run/update/delete de acompanhamento. Um erro de conflito geralmente significa que um pipeline com o mesmo nome já existe.

atualização do pipeline uip aops​

Atualizar um pipeline existente. Substituição completa (HTTP PUT) — qualquer campo que o arquivo omita é desmarcado no lado do servidor.

Argumentos​

NameRequiredFinalidade
<pipeline-id>simPipeline a ser atualizado. Deve corresponder ao campo do arquivo identifier se esse campo estiver definido.

Opções​

LongValorRequiredDescription
--file <path>PathsimArquivo JSON contendo o EditPipelineDto a ser aplicado.

Apenas as próprias chaves do EditPipelineDto são enviadas — um arquivo carregando uma chave não reconhecida (incluindo uma que está meramente incorreta de casos) é rejeitado imediatamente em vez de ser descartado silenciosamente como um apagamento parcial.

Formato dos dados (--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 reflete a solicitação que foi enviada, não o arquivo como lido do disco.

exclusão do pipeline do uip aops​

Excluir um pipeline por identificador. Permanente — as execuções em execução não são interrompidas automaticamente, mas novas execuções são rejeitadas imediatamente.

Argumentos​

NameRequiredFinalidade
<pipeline-id>simIdentificador do pipeline de pipeline list.

Opções​

LongDescription
-y, --yesObrigatório. Confirma esta operação irreversível.

Formato dos dados (--output json)​

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

execução do pipeline do uip aops​

Dispare uma execução de pipeline. Retorna 202 imediatamente — a execução é enfileirada de forma assíncrona.

Argumentos​

NameRequiredFinalidade
<pipeline-id>simIdentificador do pipeline de pipeline list.

Formato dos dados (--output json)​

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

Use pipeline executions <pipeline-id> para descobrir o novo ID de execução e, em seguida, execution logs --follow para rastreá-lo.

salvar-e-executar pipeline do uip aops​

Persiste um DTO de pipeline a partir do JSON e execute-o imediatamente.

Opções​

LongValorRequiredDescription
--file <path>PathsimArquivo JSON contendo o PipelineDto para salvar e executar.
--telemetry-flow-id <id>StringnãoID de fluxo de telemetria para correlação no lado do servidor.

Formato dos dados (--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 é removido do latestPipelineExecution do pipeline persistente para encadeamento imediato em execution logs --follow; é null se o campo estiver ausente.

execuções de pipeline do uip aops​

Listar execuções de um pipeline.

Argumentos​

NameRequiredFinalidade
<pipeline-id>simIdentificador do pipeline de pipeline list.

Opções​

LongValorDescription
--offset <n>Número inteiroNúmero a ignorar. Deve ser um múltiplo de --limit. Padrão 0.
--limit <n>Número inteiroMáximo a ser retornado. 20Padrão.

Formato dos dados (--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" } ]
}

Encontre um com execution get <execution-id> para o DTO completo (modo de execução, usuário de disparo, jobExecutionIdentifier, código de falha).

execuções de pipeline do uip aops- Bulk​

Buscar metadados para várias execuções de pipeline em uma viagem de ida e volta.

Opções​

LongValorRequiredDescription
--ids <csv>separados por vírgulasimIdentificadores de execução do pipeline (de pipeline executions) — não IDs do pipeline.

Formato dos dados (--output json)​

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

Execução do uip aops​

Inspecionar e controlar execuções de pipelines. Todos os verbos, exceto get aceitam um posicional <execution-id> (a CLI pesquisa o jobKey subjacente para você) ou --job-key <key> para ignorar essa pesquisa quando você já a tiver. get é chaveado apenas pelo ID de execução.

Execução do uip aops obter​

Busca os metadados de uma execução de pipeline por ID de execução.

Argumentos​
NameRequiredFinalidade
<execution-id>simDe pipeline executions <pipeline-id>.
Opções​
LongDescription
--with-argumentsBusca também os argumentos de entrada do runtime com os quais o pipeline foi executado (JSON analisado ou a string bruta se a análise falhar). Uma viagem extra de ida e volta.
Formato dos dados (--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" } } }

Use o jobExecutionIdentifier retornado como --job-key para logs/details/stop ignorar sua pesquisa automática.

logs de execução do uip aops​

Busca logs para uma execução.

Argumentos​
NameRequiredFinalidade
[execution-id]condicionalmenteObrigatório, a menos que --job-key esteja definido; necessário, independentemente de --follow estar definido (a pesquisa de estado é execution-id-keyed).
Opções​
LongValorDescription
--job-key <key>StringUse esta chave de trabalho diretamente, ignorando a pesquisa do ID de execução.
--followBandeiraTransmita logs até que a execução atinja um estado terminal (Successful/Faulted/Stopped).
--limit <n>Número inteiroTamanho da página por busca de log. 200Padrão.
--poll-interval <ms>Número inteiroIntervalo entre pesquisas quando --follow está definido. Padrão 2000.
--timeout <ms>Número inteiroTempo máximo a seguir antes de parar. Padrão 1800000 (30 minutos).

Sem --follow: imprime a fatia de log atual e sai (Code: "ExecutionLogs"). Com --follow: as linhas de log fluem para o stderr conforme elas chegam (não sujeitas a --log-level, não capturadas por --log-file — redireciona o stderr explicitamente para mantê-las), e o stdout emite um envelope final com o estado terminal e a contagem de linhas (Code: "ExecutionLogsFollowed").

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

detalhes de execução do uip aops​

Busque o documento de detalhes da execução do trabalho subjacente — robô, máquina, versão e contexto do host. Útil ao triar uma falha para ver em qual executor ela foi executada.

Argumentos​
NameRequiredFinalidade
[execution-id]condicionalmenteObrigatório, a menos que --job-key esteja definido.
Opções​
LongValorDescription
--job-key <key>StringUse esta chave de trabalho diretamente, ignorando a pesquisa do ID de execução.
Formato dos dados (--output json)​
{ "Code": "ExecutionDetails", "Data": {} }
{ "Code": "ExecutionDetails", "Data": {} }

interrupção da execução do uip aops​

Solicite uma interrupção na execução de um pipeline. Idempotente — chamá-lo em uma execução já terminal retorna o estado atual sem erro.

Argumentos​
NameRequiredFinalidade
[execution-id]condicionalmenteObrigatório, a menos que --job-key esteja definido; necessário, independentemente de --wait estar definido.
Opções​
LongValorDescription
--job-key <key>StringUse esta chave de trabalho diretamente, ignorando a pesquisa do ID de execução.
--waitBandeiraPesquise até que a execução seja liquidada no terminal em vez de retornar imediatamente.
--poll-interval <ms>Número inteiroIntervalo entre pesquisas quando --wait está definido. Padrão 2000.
--timeout <ms>Número inteiroTempo máximo de espera quando --wait está definido. Padrão 300000 (5 minutos).
Exemplos​
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
Formato dos dados (--output json)​
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }

Com --wait, o envelope final é Code: "ExecutionStopped" com o state resolvido. Chamar stop em uma execução que já é terminal retorna Code: "ExecutionAlreadyTerminal" em vez de emitir novamente a interrupção.

  • uip aops — visão geral e conceitos.
  • connections — descubra o repositório a partir do qual um pipeline é criado.
  • projects — descubra o processo ao qual um pipeline está vinculado.

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