uip Insights-Warnungen

Syntax und Optionen für „uip Insights Alerts“, wodurch Echtzeit-Warnungsdefinitionen von UiPath Insights gelesen werden.

uip insights alerts liest UiPath Insights Echtzeit-Warnungsdefinitionen – die in Insights konfigurierten Warnungsregeln, nicht den Verlauf ihrer Auslösung (siehe Alert-History ). Dies ist eine schreibgeschützte Oberfläche: Es gibt kein Verb zum Erstellen, Aktualisieren oder Löschen.

Hinweis:

Diese Routen sind funktionsgesteuert für Cloud- und dedizierte SaaS-Bereitstellungen. Bei anderen Bereitstellungstypen schlägt der Befehl mit einem ConfigError fehl, der angibt, dass die Routen nicht bereitgestellt werden, anstatt mit einem leeren Ergebnis.

Zusammenfassung

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

Alle Verben berücksichtigen die globalen Optionen und die Standardaustrittscodes. Keines dieser Verben akzeptiert -t, --tenant – sie verwenden den während uip login ausgewählten Mandanten.

Liste der UIP Insights-Warnungen

Listen Sie Warnungsdefinitionen auf, die für den aktuellen Anrufer sichtbar sind. Übergeben Sie --agentic, um die Definitionen in einem Prozessschlüssel anstelle der mandantenweiten Liste aufzulisten.

Optionen

Markieren	Beschreibung
--agentic	Verwenden Sie die agentische Route, eingeschränkt auf einen Prozessschlüssel. Erfordert --process-key.
--process-key <key>	Prozessschlüssel, auf den die Agent-Liste zugeordnet werden soll. Nur mit --agentic gültig; Das Übergeben ohne --agentic ist ein Validierungsfehler.
-l, --limit <number>	Maximale Anzahl zurückzugebender Zeilen. Die Standardeinstellung ist 50.
-o, --offset <number>	Zeilen, die übersprungen werden sollen, bevor Ergebnisse zurückgegeben werden.

Die Paginierung ist clientseitig: Das Back-End gibt die vollständige unpaginierte Liste zurück und die CLI schneidet sie nach dem Abrufen ab.

Beispiele

uip insights alerts list

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

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

Datenform

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

Zeilen sind eine geschlossene Zulassungslistenprojektion – hier nicht angezeigte Felder (wie die unformatierte gespeicherte Abfrage) werden nie ausgegeben. Feldnamen sind in BinnenMajuskele, die von den meisten anderen uip -Befehlen verwendet werden. Wenn engine eine Warnung vom aggregierten Typ ist, kann die Zeile auch condition (eine visuell lesbare Darstellung der Triggerbedingung der Warnung) und conditionVisible (ob diese Darstellung verfügbar war) enthalten.

Abrufen von UIP Insights-Warnungen

Rufen Sie eine Warnungsdefinition anhand ihrer Integer-ID ab.

Argumente

• <alert-id> (erforderlich) – Die Integer-ID der Warnungsdefinition (von alerts list).

Beispiel

uip insights alerts get 42

Datenform

Die gleiche Zeilenform wie ein Element des Data -Arrays von alerts list unter 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": []
  }
}

Ein Wert von 404 bedeutet hier, dass die Warnungs-ID im aktuellen Mandanten nicht vorhanden ist – übergeben Sie eine gültige ID von alerts list.

Überprüfungsberechtigung für UIP Insights-Warnungen

Überprüfen Sie, ob der aktuelle Mandant eine Berechtigung zu Insights-Warnungen bestätigt hat.

Beispiel

uip insights alerts check-entitlement

Datenform

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

Ein 403 bei alerts list/alerts get bedeutet in der Regel, dass der Zugriff auf den Orchestrator-Ordner des Aufrufers nicht gelöst werden konnte, anstatt ein Berechtigungsproblem – überprüfen Sie zuerst die aktiven Mandanten- und Ordnerberechtigungen und verwenden Sie check-entitlement anschließend, um die Berechtigung zu bestätigen Insbesondere.

Zugehörig

• Alert-History – wenn eine Warnung ausgelöst wurde, im Gegensatz zu ihrer Definition.
• Alert-bereichert – wo eine Warnungsbenachrichtigung gesendet wird (das deliveryId für eine Zeile hier).

Siehe auch

• Insights-Übersicht