Alertas de UIP Insights

Sintaxis y opciones para `alertas de UIP Insights`, que lee las definiciones de alerta en tiempo real de UiPath Insights.

uip insights alerts lee las definiciones de alerta en tiempo real de UiPath Insights: las reglas de alerta configuradas en Insights, no el historial de cuándo se activaron (consulta el historial de alertas para ello). Esta es una superficie de solo lectura: no hay verbo crear, actualizar o eliminar.

Nota:

Estas rutas están controladas por características a las implementaciones en la nube y SaaS dedicado. En otros tipos de implementación, el comando falla con un ConfigError que indica que las rutas no se sirven, en lugar de un resultado vacío.

Sinopsis

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

Todos los verbos respetan las opciones globales y los códigos de salida estándar. Ninguno de estos verbos acepta -t, --tenant: utilizan el tenant seleccionado durante uip login.

lista de alertas de uip insights

Enumera las definiciones de alerta visibles para la persona que llama actual. Transmite --agentic para enumerar las definiciones en el ámbito de una clave de proceso en lugar de la lista de todo el tenant.

Opciones

Marca	Descripción
--agentic	Utiliza la ruta agéntica, con ámbito en una clave de proceso. Requiere --process-key.
--process-key <key>	Clave de proceso para el ámbito de la lista de agentes. Solo válido con --agentic; pasarlo sin --agentic es un error de validación.
-l, --limit <number>	Máximo de filas para devolver. El valor predeterminado es 50.
-o, --offset <number>	Filas a omitir antes de devolver resultados.

La paginación es del lado del cliente: el backend devuelve la lista completa sin paginar y la CLI la corta después de recuperarla.

Ejemplos

uip insights alerts list

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

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

Forma de datos

{
  "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 }
}

Las filas son una proyección de lista de permisos cerrada: los campos que no se muestran aquí (como la consulta almacenada sin procesar) nunca se emiten. Los nombres de campo son CamelCase, a diferencia de la convención PascalCase utilizada por la mayoría de los otros comandos uip. Cuando engine es una alerta de tipo agregado, la fila también puede incluir condition (una representación legible por humanos de la condición de desencadenador de la alerta) y conditionVisible (si esa representación estaba disponible).

Obtener alertas de UIP Insights

Obtenga una definición de alerta por su ID entero.

Argumentos

• <alert-id> (obligatorio) : el ID entero de la definición de alerta (de alerts list).

Ejemplo

uip insights alerts get 42

Forma de datos

La misma forma de fila que un elemento de la matriz Data de alerts list, en 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": []
  }
}

Un 404 aquí significa que el ID de alerta no existe en el tenant actual: pase un ID válido de alerts list.

comprobación de derechos de alertas de uip insights

Comprueba si el tenant actual tiene derecho a las alertas de Insights.

Ejemplo

uip insights alerts check-entitlement

Forma de datos

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

Un 403 en alerts list/alerts get suele significar que el acceso a la carpeta de Orchestrator de la persona que llama no se ha podido resolver en lugar de un problema de derecho: compruebe primero los permisos de tenant y carpeta activos, y utilice check-entitlement como seguimiento para confirmar el derecho específicamente.

Relacionado

• historial-de-alertas : cuándo se disparó una alerta, a diferencia de cómo se define.
• entregas-alerta : donde se envía una notificación de alerta (el deliveryId en una fila aquí).

Ver también

• Descripción general de Insights