uip maestro flow instance

Syntax and options for `uip maestro flow instance`, which inspects and steers individual Flow process instances.

uip maestro flow instance inspeciona e orienta instâncias de processos individuais — uma execução de um processo de fluxo 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 flow instance list                <instance-id>             -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro flow instance get                 <instance-id>             -f <folder-key>
uip maestro flow instance pause               <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance resume              <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance cancel              <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance retry               <instance-id>             -f <folder-key> [--comment <text>]
uip maestro flow instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro flow instance variables           <instance-id>             -f <folder-key> [--parent-element-id <id>]
uip maestro flow instance incidents           <instance-id>             -f <folder-key>
uip maestro flow instance asset               <instance-id>             -f <folder-key>
uip maestro flow instance cursors             <instance-id>             -f <folder-key>
uip maestro flow instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro flow 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

uip maestro flow instance list

Liste instâncias em uma pasta, com escopo para Processes de fluxo (processType=Flow).

Opções

Opção	Padrão	Description
-l, --limit <n>	DEFAULT_PAGE_SIZE	Número de itens a serem retornados (1 a 10000).
--offset <n>	0	Nú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 é uma matriz de objetos de instância de processo.

uip maestro flow instance get

Buscar uma única instância por ID.

Formato dos dados: Code: "InstanceGet", Data é o objeto da instância do processo.

uip maestro flow instance pause

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

uip maestro flow instance resume

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

uip maestro flow instance cancel

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

uip maestro flow instance retry

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

uip maestro flow instance migrate

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

uip maestro flow instance variables

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.

uip maestro flow instance incidents

Obtenha incidentes para uma instância específica.

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

uip maestro flow instance asset

Busque a definição do fluxo (o ativo .flow ) anexada à versão desta instância — útil ao depurar para ver o gráfico exato que a instância executou.

Formato dos dados: Code: "InstanceAsset", Data é o Fluxo JSON.

uip maestro flow instance cursors

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.

uip maestro flow instance goto

Mova um cursor de execução de um elemento para outro. Útil para recuperar uma instância com falha ignorando ou tentando novamente nós específicos.

Argumentos

• <instance-id> (necessário)
• <transitions> (necessário) — Array JSON de transições, cada uma com sourceElementId e targetElementId.

uip maestro flow instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Node_1","targetElementId":"Node_3"}]' \
  --folder-key c3d4e5f6-…

A CLI valida as análises JSON e cada entrada tem ambos os IDs antes de chamar a API.

Formato dos dados

Code: "InstanceGoto".

uip maestro flow instance element-executions

Obtenha o histórico de execução por elemento para uma instância (o que foi executado, quando e com qual resultado).

Formato dos dados

Code: "InstanceElementExecutions", Data é o histórico de execução por elemento.

Exemplos

# Paginate through instances for a specific process
uip maestro flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50

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

# Skip a faulted node by moving the cursor forward, then retry
uip maestro flow instance cursors <id> --folder-key <k>
uip maestro flow instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro flow instance retry   <id> --folder-key <k>

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

Veja também

• uip maestro flow incident — ler incidentes desanexados de uma instância específica
• uip maestro flow job — a visualização de trabalho de uma execução de instância
• uip maestro flow process — iniciar novas instâncias
• Trabalhos do Orchestrator
• Visão geral do fluxo