alertas do uipath insights

Sintaxe e opções para "alertas do Uiip Insights", que lê as definições de alerta em tempo real do UiPath Insights.

uip insights alerts lê as definições de alerta em tempo real do UiPath Insights — as regras de alerta configuradas no Insights, não o histórico de quando elas foram disparadas (consulte histórico do alerta para isso). Essa é uma superfície somente leitura: não há verbo criar, atualizar ou excluir.

Observação:

Essas rotas são fechadas para implantações Cloud e SaaS dedicado. Em outros tipos de implantação, o comando falha com um ConfigError indicando que as rotas não são fornecidas, em vez de um resultado vazio.

Resumo

uip insights alerts list [--agentic --process-key <key>] [-l <n>] [-o <n>]
uip insights alerts get <alert-id>
uip insights alerts check-entitlement

Todos os verbos honram as opções globais e os códigos de saída padrão. Nenhum desses verbos aceita -t, --tenant — eles usam o tenant selecionado durante uip login.

lista de alertas do uip insights

Lista as definições de alerta visíveis para o chamador atual. Passe --agentic para listar as definições com escopo para uma chave de processo em vez da lista de todo o tenant.

Opções

Bandeira	Description
--agentic	Use a rota com agente, com escopo de uma chave de processo. Requer --process-key.
--process-key <key>	Chave de processo para delimitar a lista de agentes. Válido apenas com --agentic; passá-lo sem --agentic é um erro de validação.
-l, --limit <number>	Máximo de linhas a serem retornadas. O padrão é 50.
-o, --offset <number>	Linhas a ignorar antes de retornar resultados.

A paginação é do lado do cliente: o back-end retorna a lista completa não paginada, e a CLI a fatia após a busca.

Exemplos

uip insights alerts list

uip insights alerts list --agentic --process-key MyAgenticProcess

uip insights alerts list --limit 10 --offset 10

Formato dos dados

{
  "Code": "InsightsAlertsList",
  "Data": [
    {
      "id": 42,
      "name": "High failure rate",
      "severity": "ERROR",
      "isActive": true,
      "engine": "aggregate",
      "metric": "FailedJobCount",
      "metricState": "Failed",
      "operator": "GreaterThan",
      "threshold": 5,
      "windowSeconds": 3600,
      "deliveryId": 7,
      "autoSnoozeSeconds": 1800,
      "snoozedUntil": null,
      "lastTriggeredAt": 1714003200,
      "processKey": "Invoicing",
      "folderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "projectKey": null,
      "processVersion": "1.0.0",
      "scopes": [{ "field": "FolderName", "values": ["Finance"] }]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}

As linhas são uma projeção de lista de permissões fechada — campos não mostrados aqui (como a consulta bruta armazenada) nunca são emitidos. Os nomes de campos são CamelCase, ao contrário da convenção PascalCase usada pela maioria dos outros uip comandos. Quando engine é um alerta do tipo agregado, a linha também pode incluir condition (uma renderização legível por humanos da condição de gatilho do alerta) e conditionVisible (se essa renderização estava disponível).

obtenção de alertas do uip insights

Obter uma definição de alerta por seu ID inteiro.

Argumentos

• (necessário) <alert-id> o ID inteiro da definição do alerta (de alerts list).

Exemplo

uip insights alerts get 42

Formato dos dados

Mesma forma de linha que um elemento da matriz Data de alerts list, sob Code: "InsightsAlertGet".

{
  "Code": "InsightsAlertGet",
  "Data": {
    "id": 42,
    "name": "High failure rate",
    "severity": "ERROR",
    "isActive": true,
    "engine": "aggregate",
    "metric": "FailedJobCount",
    "metricState": "Failed",
    "operator": "GreaterThan",
    "threshold": 5,
    "windowSeconds": 3600,
    "deliveryId": 7,
    "autoSnoozeSeconds": 1800,
    "snoozedUntil": null,
    "lastTriggeredAt": 1714003200,
    "processKey": "Invoicing",
    "folderKey": "f0f0f0f0-0000-0000-0000-000000000001",
    "projectKey": null,
    "processVersion": "1.0.0",
    "scopes": []
  }
}

Um 404 aqui significa que o ID do alerta não existe no tenant atual — transmita um ID válido de alerts list.

verificação de alertas do uip insights

Verifique se o tenant atual tem direito confirmado aos alertas do Insights.

Exemplo

uip insights alerts check-entitlement

Formato dos dados

{
  "Code": "InsightsAlertEntitlement",
  "Data": { "entitled": true }
}

Um 403 em alerts list/alerts get geralmente significa que o acesso à pasta do Orchestrator do chamador não pôde ser resolvido, em vez de um problema de direito. Verifique primeiro as permissões de tenant e pasta ativas e use check-entitlement como acompanhamento para confirmar o direito especificamente.

Relacionado

• histórico-alerta — quando um alerta foi disparado, em vez de como ele é definido.
• alerta-entrega — para onde uma notificação de alerta é enviada (o deliveryId em uma linha aqui).

Veja também

• Visão geral do Insights