UIP Insights のアラート

「uip insights alerts」の構文とオプション。「uip insights alerts」は、UiPath Insights のリアルタイムのアラートの定義を読み取ります。

uip insights alerts は、UiPath Insights のリアルタイムのアラート定義です。つまり、アラートが発生した日時の履歴ではなく、Insights で設定されたアラート ルールです (詳細については 、「alert-history 」をご覧ください)。これは読み取り専用のサーフェスであり、作成、更新、削除動詞はありません。

注:

これらのルートは、クラウドおよび専有型の SaaS デプロイへの機能ゲートされます。他のデプロイの種類では、コマンドは失敗し、空の結果ではなく、ルートが提供されていないことを示す ConfigError が表示されます。

概要

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

すべての動詞は、 グローバル オプション と標準の 終了コードを尊重します。これらの動詞はどれも -t, --tenant を受け入れません。 uip login時に選択したテナントを使用します。

UIP Insights のアラートのリスト

現在の呼び出し元に表示されるアラート定義のリストを表示します。テナント全体のリストではなく 1 つのプロセス キーにスコープが設定された定義を一覧表示するには、 --agentic を渡します。

オプション

フラグ	説明
--agentic	1 つのプロセス キーにスコープを設定したエージェンティック ルートを使用します。--process-keyが必要です。
--process-key <key>	エージェンティック リストのスコープに使用するプロセス キー。--agenticでのみ有効です。--agenticせずに渡すと、検証エラーになります。
-l, --limit <number>	返される最大行数。既定値は 50です。
-o, --offset <number>	結果を返す前にスキップする行です。

ページネーションはクライアント側で行われます。バックエンドはページネーションされていない完全なリストを返し、CLI はそれをフェッチ後にスライスします。

例

uip insights alerts list

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

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

データシェイプ

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

行は許可リストで閉じられたプロジェクションです。ここに表示されていないフィールド (保存されている生のクエリなど) は出力されません。フィールド名は、他のほとんどの uip コマンドで使用されるパスカルケースの規則とは異なり、キャメルケースです。engineが集計タイプのアラートの場合、行にはcondition (人間が判読できるアラートのトリガー条件のレンダリング) および conditionVisible (そのレンダリングが利用可能であったかどうか) も含めることができます。

UIP Insights のアラートの取得

1 つのアラート定義を整数 ID で取得します。

引数

• <alert-id> (必須) — アラート定義の整数 ID ( alerts listから) です。

例

uip insights alerts get 42

データシェイプ

Code: "InsightsAlertGet"alerts listの Data 配列の 1 つの要素と同じ行図形です。

{
  "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": []
  }
}

ここでの 404 は、アラート ID が現在のテナントに存在しないことを意味します。 alerts listから有効な ID を渡してください。

uip insights のアラート check-entitlement

現在のテナントが Insights のアラートを受け取る資格があることが確認されているかどうかを確認します。

例

uip insights alerts check-entitlement

データシェイプ

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

alerts list/alerts get の 403 は通常、権利の問題ではなく、呼び出し元の Orchestrator フォルダー アクセス権を解決できなかったことを意味します。最初にアクティブなテナントとフォルダーの権限を確認し、check-entitlementフォローアップとして使用して、具体的に権利を確認してください。

関連

• alert-history — アラートが発生したとき (定義方法とは対照的)。
• alert-deliveries — アラート通知が送信される場所です (ここでは行の deliveryId )。

参照

• Insights の概要