instância de fluxo do UIP Maestro

Sintaxe e opções para a "instância de fluxo do UIP Maestro", que inspeciona e orienta instâncias de processos de fluxo individuais.

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.

Esta página compartilha sua implementação com uip maestro bpmn instance — os mesmos defeitos e correções se aplicam a ambas as páginas.

Resumo

uip maestro flow instance list                <instance-id>             -f <folder-key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
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 variables-set       <instance-id>             -f <folder-key> --inputs <json|@file>
uip maestro flow instance variables-all       <instance-id>             -f <folder-key>
uip maestro flow instance global-variables    <instance-id>             -f <folder-key>
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>
uip maestro flow instance element cancel      <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro flow instance element retry       <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro flow instance message send        -f <folder-key> [--inputs <json|@file>]

-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 de fluxo do uip Maestro

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. Limitado em 1-500 — mais rigorosa do que a convenção habitual 1-10000 desta CLI, porque as páginas da API de instâncias por cursor em vez de deslocamento.
--next-page <cursor>	—	Cursor de Pagination.NextPage de uma resposta anterior. Essa API não é compatível com --offset — um --offset diferente de zero falha rapidamente com um erro dizendo para você usar --next-page em vez disso.
--process-key <k>	—	Filtra por chave de processo (GUID). Para o identificador de pacote pontilhado,--package-id use.
--package-id <id>	—	Filtrar por ID de pacote.
--error-code <code>	—	Filtra por código de erro.
--status <status>	—	Filtre por status da instância. Repetível (semântica OR). Valores: Canceling, Cancelled, Completed, Faulted, Paused, Pausing, Pending, Resuming, Retrying, Running, Upgrading.
--from-date <iso-8601>	—	Inclua apenas instâncias iniciadas por ou depois desse registro de data/hora. Por exemplo 2026-01-01T00:00:00Z).
--to-date <iso-8601>	—	Inclui apenas instâncias iniciadas antes ou depois deste carimbo de data/hora.

Formato dos dados

Code: "InstanceList" Data é uma matriz de objetos de instância de processo.

instância de fluxo do uip Maestro obter

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 fluxo do uip Maestro

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

Retomação da instância de fluxo do uip Maestro

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

instância de fluxo do uip Maestro cancelamento

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

nova tentativa da instância do fluxo do uip Maestro

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

migração da instância do fluxo 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 fluxo do Maestro uip

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.

variáveis-set de instância de fluxo do uip Maestro

Corrigir variáveis (atualizar parcialmente) para uma instância.

Opções

Opção	Description
--inputs <value>	Carga de variáveis de patch como uma string JSON, um caminho @file ou tabulada via stdin.

Formato dos dados

Code: "InstanceVariablesSet".

variáveis de instância de fluxo do uip Maestro

Obtenha todas as variáveis de uma instância, incluindo variáveis de subprocesso (ao contrário de variables, que tem o escopo limitado para o processo de nível superior, a menos que --parent-element-id seja passado).

Formato dos dados

Code: "InstanceVariablesAll".

global-variáveis da instância do fluxo do uip Maestro

Obter as variáveis globais de uma instância (compartilhadas por todo o processo, sem escopo para nenhum elemento).

Formato dos dados

Code: "InstanceGlobalVariables".

elemento de instância de fluxo do uip Maestro cancelamento

Cancele um elemento específico em uma instância em execução, em vez da instância inteira.

Argumentos

• <instance-id> (necessário)
• <element-id> (necessário)

Opções

• --comment <text> — comentário opcional gravado com a operação.

Formato dos dados

Code: "ElementCanceled".

nova tentativa do elemento de instância do fluxo do uip Maestro

Tente novamente um elemento com falha específico dentro de uma instância, em vez de tentar novamente a instância inteira.

Argumentos

• <instance-id> (necessário)
• <element-id> (necessário)

Opções

• --comment <text> — comentário opcional gravado com a operação.

Formato dos dados

Code: "ElementRetried".

Envio de mensagem de instância de fluxo do uip Maestro

Envie uma mensagem para assinaturas de fluxo de trabalho ouvindo nesta pasta — usada para entregar um evento externo a um fluxo em execução (por exemplo, uma carga de webhook que o processo está esperando).

Opções

Opção	Description
-f, --folder-key <key>	(obrigatório) Chave da pasta (GUID).
--inputs <value>	Carga da mensagem como uma string JSON, um caminho @file ou tabulada via stdin.

Formato dos dados

Code: "MessageSent".

incidentes de instância de fluxo do uip Maestro

Obtenha incidentes para uma instância específica.

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

ativo de instância de fluxo do uip Maestro

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.

cursores de instância de fluxo 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 de fluxo do uip Maestro geto

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

execuções de elementos de instância de fluxo do uip Maestro

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