UIP またはトリガー

「uip またはトリガー」の構文とオプション - Orchestrator のタイム トリガー、キュー トリガー、API トリガーを管理します。

Orchestrator のトリガーを管理する: 時刻 (スケジュール)、キュー、APIタイム トリガーとキュー トリガーはフォルダー範囲です。API トリガーはテナント範囲です。すべての動詞は --type <time|queue|api> を受け入れます(デフォルト time)。

リソース間の規則 (認証、フォルダー スコープ、キーの種類、出力エンベロープ) については、「 uip or の概要」をご覧ください。

概要

uip or triggers list     [--type <type>] [--folder-path <path> | --folder-key <key>] [-n <name>] [--enabled | --disabled] [--sort-by <field>] [--all-fields]
uip or triggers get      <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] [--all-fields]
uip or triggers create   --type <type> --name <n> --release-key <k> --runtime-type <r> --job-priority <p> [type-specific flags]
uip or triggers update   <trigger-key> --type <type> [type-specific flags] [--enabled | --disabled]
uip or triggers delete   <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] --yes
uip or triggers history  <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] [-l <n>] [--offset <n>] [--all-fields]

注:

専用の enable や disable コマンドはありません。代わりに update <trigger-key> --enabled または update <trigger-key> --disabled を使用してトリガーを切り替えます (この 2 つのフラグは相互に排他的です)。

リスト (List)

トリガーのリストを取得します。フィルター: -n, --name、 --enabled、 --disabled (相互に排他的)。--sort-by <field> 結果を並べ替えます。--all-fields は、選定されたサブセットではなく完全な API 応答を返します。

uip or triggers list --type time --folder-path Shared --enabled

get

キーでトリガーを取得します。--all-fields は、選定されたサブセットではなく完全な API 応答を返します。

作成

トリガーを作成します。必須のフラグ: --name、 --release-key、 --runtime-type <Serverless|Unattended|Headless|NonProduction|AgentService>、 --job-priority <Low|Normal|High> (既定 Normal)。

型固有:

• 時間 には --cron (Quartz 6フィールド形式)が必要であり、オプションで --time-zone。
• キュー には --queue-key が必要です ( --items-threshold、 --max-jobs、 --items-per-job、 --activate-on-completeを受け入れます)。
• API には --slug と --method <Get|Post|Put|Delete> が必要です (必要に応じて --calling-mode)。

共通: -d, --description、 --input-arguments <json>、 --calendar-key、 --stop-strategy <SoftStop|Kill>、 --kill-process-expression、 --resume-on-same-context、 --run-as-me、反復可能な --target "machine=<guid>,user=<guid>,session=<int>"、 --mapping-mode <dynamic|strict> (既定 dynamic、フォルダーの [アカウントとマシンのマッピングを有効化] がオンになっている場合に strict を使用します)。

uip or triggers create --type time \
  --name NightlyInvoices --release-key <release-guid> \
  --runtime-type Unattended --job-priority Normal \
  --folder-path Shared --cron "0 0 2 * * ?" --time-zone UTC

更新

キーで更新。createと同じ型固有のフラグ 、すべて任意です。ブール値を設定解除するには、対応する --no-* を使用します (例: --no-activate-on-complete、 --no-resume-on-same-context、 --no-run-as-me)。--enabled または --disabled を渡すと、トリガーのステートが切り替わります (相互に排他的)。

uip or triggers update <trigger-key> --type time --disabled

削除

トリガーをキーで削除する-y, --yesが必要 — CLI で破壊的な操作が求められることはありません。

uip or triggers delete <trigger-key> --type time --yes

履歴

トリガーの実行履歴 (火災ログ) を表示する-l, --limit/--offsetでページネーションされます。--all-fields は、選定されたサブセットではなく完全な API 応答を返します。トリガーが起動しなかった理由 (ライセンスがない、マシンがない、無効化されているなど) を診断するのに役立ちます。

終了コード

共有コントラクトの 終了コード を参照してください。-y, --yesを省略するとdelete1終了します。

関連コマンド

• uip or processes — triggers createの--release-keyを取得します。
• uip or queues — キュー トリガーで--queue-keyするためのキュー キー。

参照

• uip orの概要—すべてのuip or動詞に共通する規則。
• 方法: Orchestrator のアセットとキューを管理する — トリガーの作成パターン。