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]
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 切换触发器(这两个标志互斥)。
列表
列出触发器。筛选器:-n, --name、--enabled、--disabled(互斥)。--sort-by <field> 对结果进行排序。--all-fields 返回完整的 API 响应,而不是策划的子集。
uip or triggers list --type time --folder-path Shared --enabled
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
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
uip or triggers update <trigger-key> --type time --disabled
删除
按密钥删除触发器。需要 -y, --yes — CLI 从不提示进行破坏性操作。
uip or triggers delete <trigger-key> --type time --yes
uip or triggers delete <trigger-key> --type time --yes
历史
显示触发器执行历史记录(触发日志)。通过 -l, --limit / --offset 分页。--all-fields 返回完整的 API 响应,而不是策划的子集。用于诊断触发器未触发原因(缺少许可证、没有计算机、已禁用等)。
退出代码
请参阅共享合同的退出代码。如果省略 delete,1 将退出 -y, --yes。
相关命令
uip or processes— 获取--release-key的triggers create。uip or queues— 队列触发器上--queue-key队列密钥。
另请参阅
uip or概述— 每个uip or动词的共享约定。- 操作方法:管理 Orchestrator 资产和队列— 触发器创建模式。