UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

instâncias do uip Maestro

uip maestro instance inspeciona e orienta instâncias de processos individuais — uma execução de um processo do Maestro publicado. O nome do comando é ímpar (instance) mesmo que a entrada da barra lateral diga instances.

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 instance list                                  -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get                 <instance-id>     -f <folder-key>
uip maestro instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents           <instance-id>     -f <folder-key>
uip maestro instance asset               <instance-id>     -f <folder-key>
uip maestro instance cursors             <instance-id>     -f <folder-key>
uip maestro instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions  <instance-id>     -f <folder-key>
uip maestro instance list                                  -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get                 <instance-id>     -f <folder-key>
uip maestro instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents           <instance-id>     -f <folder-key>
uip maestro instance asset               <instance-id>     -f <folder-key>
uip maestro instance cursors             <instance-id>     -f <folder-key>
uip maestro instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions  <instance-id>     -f <folder-key>

-f, --folder-key <key> é necessário em cada subcomando.

Opções comuns

  • -f, --folder-key <key> necessário) — chave de pasta (GUID).
  • --comment <text> (apenas comandos de operação) — comentário opcional gravado com a operação. Enviado como uma string vazia se omitido.

Subcomandos

lista de instâncias uip Maestro

Liste as instâncias em uma pasta, com escopo de processType=ProcessOrchestration.

Opções
OpçãoPadrãoDescription
-l, --limit <n>DEFAULT_PAGE_SIZENúmero de itens a serem retornados (1 a 10000).
--offset <n>0Número de itens a ignorar (0-1000000).
--process-key <k>Filtra por chave de processo.
--package-id <id>Filtrar por ID de pacote.
--error-code <code>Filtra por código de erro.
Formato dos dados

Code: "InstanceList", Data is an array of process-instance objects.

instância do uip Maestro obtida

Buscar uma única instância por ID. Formato dos dados: Code: "InstanceGet", Data é o objeto da instância do processo.

pausa da instância do uip Maestro

Pausar uma instância em execução. Formato dos dados: Code: "InstancePaused".

Retomação da instância uip Maestro

Retome uma instância pausada. Formato dos dados: Code: "InstanceResumed".

instância do uip Maestro cancelamento

Cancele uma instância em execução. Formato dos dados: Code: "InstanceCanceled".

nova tentativa da instância do uip Maestro

Tente novamente uma instância com falha. Formato dos dados: Code: "InstanceRetried".

migração da instância do uip Maestro

Migre uma instância para uma versão diferente do pacote.

Argumentos: <instance-id>, <new-version> (versão do pacote de destino).

Formato dos dados: Code: "InstanceMigrated".

variáveis de instância do uip Maestro

Obtenha variáveis para uma instância.

Opções: --parent-element-id <id> filtre variáveis por elemento pai.

Formato dos dados: Code: "InstanceVariables", Data carrega a carga das variáveis de instância.

incidentes de instância do uip Maestro

Formato dos dados: Code: "InstanceIncidents", Data é uma matriz de objetos de incidentes.

ativo de instância do uip Maestro

Busque o ativo BPMN anexado à versão desta instância.

Formato dos dados: Code: "InstanceAsset", Data é a carga do ativo BPMN.

cursores de instância do uip Maestro

Obter as posições atuais do cursor — em quais elementos a instância está pausada.

Formato dos dados: Code: "InstanceCursors", Data lista as posições atuais do cursor.

instância do uip Maestro geto

Mova um cursor de execução de um elemento para outro.

Argumentos
  • <instance-id> (necessário)
  • <transitions> (necessário) — Array JSON de transições, cada uma com sourceElementId e targetElementId.
uip maestro instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-uip maestro instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…
Formato dos dados

Code: "InstanceGoto".

execuções de elementos-execuções da instância uip Maestro

Obtenha o histórico de execução por elemento para uma instância.

Formato dos dados

Code: "InstanceElementExecutions", Data is the per-element execution history.

Exemplos

# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

# Pause, fix, resume
uip maestro instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

# Pause, fix, resume
uip maestro instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"

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