UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

alertes uip insights

Syntaxe et options pour `uip insights alertes`, qui lit les définitions d'alerte en temps réel UiPath Insights.

uip insights alerts lit les définitions d'alertes en temps réel UiPath Insights - les règles d'alerte configurées dans Insights, et non l'historique de leur déclenchement. (Consultez l'historique des alertes pour cela). Il s'agit d'une surface en lecture seule: il n'y a pas de verbe créer, mettre à jour ou supprimer.

Remarque :

Ces routages sont limités aux déploiements Cloud et SaaS dédiés. Sur les autres types de déploiement, la commande échoue avec une ConfigError indiquant que les routages ne sont pas servis, plutôt qu'un résultat vide.

Synthèse​

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

Tous les verbes respectent les options globales et les codes de sortie standard. Aucun de ces verbes n'accepte -t, --tenant — ils utilisent le locataire sélectionné lors de uip login.

liste d'alertes uip insights​

Répertorie les définitions d'alertes visibles par l'appelant actuel. Transmettez --agentic pour répertorier les définitions limitées à une clé de processus au lieu de la liste à l'échelle du locataire.

Options​

DrapeauDescription
--agenticUtilisez la route agentique, limitée à une clé de processus. Nécessite --process-key.
--process-key <key>Clé de processus à laquelle étendre la liste des agents. Uniquement valide avec --agentic; le transmettre sans --agentic est une erreur de validation.
-l, --limit <number>Nombre maximal de lignes à renvoyer. La valeur par défaut est 50.
-o, --offset <number>Lignes à ignorer avant de renvoyer des résultats.

La pagination est côté client: le backend renvoie la liste non paginée complète et la CLI la coupe après la récupération.

Exemples​

uip insights alerts list

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

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

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

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

Format des données​

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

Les lignes sont une prévision de liste d'autorisation fermée - les champs non affichés ici (comme la requête stockée brute) ne sont jamais émis. Les noms de champ sont en casse camel, contrairement à la convention PascalCase utilisée par la plupart des autres commandes uip. Lorsque engine est une alerte de type agrégé, la ligne peut également inclure condition (une représentation lisible par un humain de la condition du déclencheur de l'alerte) et conditionVisible (si ce rendu était disponible).

alertes uip insights - Obtenir​

Obtenez une définition d'alerte par son ID entier.

Arguments​

  • <alert-id> (obligatoire) : l'ID entier de la définition d'alerte (à partir de alerts list).

Exemple​

uip insights alerts get 42
uip insights alerts get 42

Format des données​

Même forme de ligne qu'un élément du tableau Data de alerts list, sous 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": []
  }
}
{
  "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 message 404 signifie que l’ID d’alerte n’existe pas dans le locataire actuel. Transmettez un ID valide à partir de alerts list.

uip insights - Alertes - Droit de vérification​

Vérifiez si le locataire actuel a droit aux alertes Insights.

Exemple​

uip insights alerts check-entitlement
uip insights alerts check-entitlement

Format des données​

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

Un processus 403 sur alerts list/alerts get signifie généralement que l’accès au dossier Orchestrator de l’appelant n’a pas pu être résolu plutôt qu’un problème de droit. Vérifiez d’abord les autorisations de locataire et de dossier actives, puis utilisez check-entitlement comme suivi pour confirmer le droit spécifiquement.

  • alerte-historique — lorsqu'une alerte se déclenche, par opposition à la façon dont elle est définie.
  • alert-deliveries — où une notification d'alerte est envoyée (le deliveryId sur une ligne ici).

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour