“uip 或队列”的语法和选项,用于管理事务工作项目的 Orchestrator 队列容器。
管理 Orchestrator队列— 自动化以事务方式处理的工作项目的容器。队列是文件夹范围内的。有关队列中每个项目的操作,请参阅uip or queue-items 。
有关跨资源约定(身份验证、文件夹作用域、密钥类型、输出信封),请参阅uip or概述。
大纲
uip or queues list --folder-path <path> | --folder-key <key> [-n <name>] [-l <n>] [--offset <n>] [--sort-by <field>]
uip or queues get <queue-key>
uip or queues create <name> --folder-path <path> | --folder-key <key> [options below]
uip or queues update <queue-key> [options as for create]
uip or queues delete <queue-key> --yes [-f]
uip or queues get-stats --key <queue-key> [--folder-path <path> | --folder-key <key>] [-n <name>] [--from <date>] [--to <date>] [--all-fields]
uip or queues get-folders <queue-key>
uip or queues share <queue-key> --folder-path <path> | --folder-key <key>
uip or queues unshare <queue-key> --folder-path <path> | --folder-key <key>
uip or queues list --folder-path <path> | --folder-key <key> [-n <name>] [-l <n>] [--offset <n>] [--sort-by <field>]
uip or queues get <queue-key>
uip or queues create <name> --folder-path <path> | --folder-key <key> [options below]
uip or queues update <queue-key> [options as for create]
uip or queues delete <queue-key> --yes [-f]
uip or queues get-stats --key <queue-key> [--folder-path <path> | --folder-key <key>] [-n <name>] [--from <date>] [--to <date>] [--all-fields]
uip or queues get-folders <queue-key>
uip or queues share <queue-key> --folder-path <path> | --folder-key <key>
uip or queues unshare <queue-key> --folder-path <path> | --folder-key <key>
列表
列出文件夹中的队列。需要--folder-path或--folder-key 。筛选:-n, --name <name>。--sort-by <field> 对结果进行排序(默认为 Id desc)。
uip or queues list --folder-path Shared
uip or queues list --folder-path Shared
get
按密钥获取队列详细信息。跨文件夹。
创建
在文件夹中创建队列。需要 <name>。标记:-d, --description、--max-retries、--sla-in-minutes <minutes>、--risk-sla-in-minutes <minutes>、--auto-retry / --no-auto-retry(默认开启)、--retry-abandoned-items / --no-retry-abandoned-items、--enforce-unique-reference / --no-enforce-unique-reference、--encrypted, --retention-action <Delete|Archive|None>(默认 Delete)、--retention-period <days>(默认 30)、--stale-retention-action(默认 Delete)、--stale-retention-period <days>(默认 180)。
uip or queues create InvoiceQueue --folder-path Shared \
--max-retries 3 --retention-period 90
uip or queues create InvoiceQueue --folder-path Shared \
--max-retries 3 --retention-period 90
更新
按密钥更新队列属性。跨文件夹。与create相同的标志,均为可选。
删除
按密钥删除队列。跨文件夹。需要 -y, --yes — CLI 从不提示进行破坏性操作。添加 -f, --force 以删除仍包含项目的队列 — 没有它,非空队列将被拒绝; --force 将项目与队列一起删除,隐含 --yes。
uip or queues delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or queues delete a1b2c3d4-0000-0000-0000-000000000010 --yes
获取统计信息
获取队列的处理统计信息(项目计数、异常计数、处理时间)。与此页面上的所有其他动词不同,队列由必填选项而非位置参数标识: --key <queue-key> 。可选 -n, --name <name>(包含匹配项,与 --key 结合使用)、--from <date>/--to <date>(ISO 8601,按上次处理日期筛选)、--all-fields。
uip or queues get-stats --key a1b2c3d4-0000-0000-0000-000000000001
uip or queues get-stats --key a1b2c3d4-0000-0000-0000-000000000001
获取文件夹、共享、取消共享
退出代码
请参阅共享合同的退出代码。如果省略 delete,1 将退出 -y, --yes。
相关命令
uip or queue-items— 队列中每个项目的操作。
另请参阅
uip or概述— 每个uip or动词的共享约定。- 操作方法:管理 Orchestrator 资产和队列— 队列项目的批量模式。