execução do agente uipath

uip agent run inicia e monitora trabalhos de agentes no Orchestrator. Internamente, cada subcomando chama os pontos de extremidade OData de trabalhos / lançamentos do Orchestrator padrão — os mesmos pontos de extremidade que uip or jobs expõe — com escopo para as versões produzidas por uip agent deploy.

Cada subcomando requer uma sessão de CLI ativa (uip login). Se nenhum --folder-id for passado, o comando usará a pasta vinculada à sessão atual.

Resumo

uip agent run start <releaseKeyOrName> [-i <json>] [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run status <jobId>                         [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run list                                   [--folder-id <id>] [--filter <odata>] [-t <tenant>] [--login-validity <minutes>]

Todos os subcomandos uip agent run respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

início da execução do agente do uip

Inicie um trabalho para uma versão de agente implantada.

Argumentos

• <releaseKeyOrName> necessário) — Uma chave de versão (GUID) ou um nome de versão. Se o valor não for um GUID, o comando executa uma pesquisa de nome no endpoint Releases OData ($filter=Name eq '<name>').

Opções

Bandeira	Padrão	Finalidade
-i, --inputs <json>	{}	Argumentos de entrada como uma string JSON. Deve ser um JSON válido.
--folder-id <id>	pasta de logon	ID da unidade do org da pasta do Orchestrator. Enviado como X-UIPATH-OrganizationUnitId.
-t, --tenant <tenant>	Tenant de logon	Tenant de destino.
--login-validity <minutes>	10	Mínimo de minutos de validade do token necessários.

Exemplos

# Start by release key (the exact key from 'agent run list')
uip agent run start a1b2c3d4-0000-0000-0000-000000000401 -i '{"input":"hello"}'

# Start by release name (resolved via OData lookup)
uip agent run start InvoiceAgent -i '{"invoiceUrl":"…"}' --folder-id 42

# Start with no inputs
uip agent run start InvoiceAgent

Formato dos dados (--output json)

{
  "Code": "AgentJobStarted",
  "Data": {
    "JobId": 12345,
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000410",
    "State": "Pending"
  }
}

JobId é o ID numérico que você passa para uip agent run status. JobKey é o equivalente do GUID, útil para referências cruzadas com a UI do Orchestrator ou comandos uip or jobs . Os trabalhos são iniciados com Strategy: ModernJobsCount e JobsCount: 1.

status de execução do agente do uip

Buscar o estado atual de um único trabalho.

Argumentos

• <jobId> (necessário) — ID numérico do trabalho do Orchestrator (de run start ou uip or jobs list).

Opções

Igual a run start (--folder-id, -t/--tenant, --login-validity).

Exemplos

# Quick status check
uip agent run status 12345

# Explicit folder
uip agent run status 12345 --folder-id 42

Formato dos dados (--output json)

{
  "Code": "AgentJobStatus",
  "Data": {
    "JobId": 12345,
    "State": "Successful",
    "ReleaseName": "InvoiceAgent",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:31:12Z",
    "Info": "…",
    "Output": { "...": "..." }
  }
}

• Os valores State espelham os estados de trabalho do Orchestrator (Pending, Running, Successful, Faulted, Stopped, Suspended, …).
• Info só está presente quando o trabalho carrega uma mensagem de status (normalmente em falha).
• Output é OutputArguments analisado como JSON. Se a análise falhar, a string bruta será retornada.

lista de execução do agente uip

Lista as versões de agentes disponíveis em uma pasta.

Argumentos

Nenhum.

Opções

Bandeira	Padrão	Finalidade
--folder-id <id>	pasta de logon	ID da unidade do org da pasta do Orchestrator.
--filter <odata>	—	Expressão $filter adicional do OData anexada à consulta padrão (que já é classificada por Name).
-t, --tenant <tenant>	Tenant de logon	Tenant de destino.
--login-validity <minutes>	10	Mínimo de minutos de validade do token necessários.

Exemplos

# List all releases in the login folder
uip agent run list

# List in a specific folder
uip agent run list --folder-id 42

# Filter by name prefix
uip agent run list --filter "startswith(Name,'Invoice')"

Formato dos dados (--output json)

{
  "Code": "AgentReleaseList",
  "Data": [
    {
      "Name": "InvoiceAgent",
      "ReleaseKey": "a1b2c3d4-0000-0000-0000-000000000401",
      "ProcessKey": "InvoiceAgent",
      "Version": "1.0.0",
      "FolderId": 42
    }
  ]
}

Uma pasta vazia retorna uma entrada de log Message (No releases found in this folder. Publish an agent first.) e nenhuma carga de sucesso.

Relacionado

• uip agent deploy — publica as versões que run list enumera.
• uip agent eval run start — o equivalente de avaliação de run start, visando o serviço do Agent Runtime em vez de um trabalho do Orchestrator.
• Orchestrator: trabalhos — a API de trabalhos completo (parar, reiniciar, logs, anexos).

Veja também

• Autenticação — sessões, tenants e --login-validity.
• Opções globais, Códigos de saída.