UIP 或日历

“uip 或日历”的语法和选项，用于管理 Orchestrator 时间触发器使用的排除日期的日历。

uip or calendars管理日历— 租户范围内的排除日期（也称为“非工作日”）列表，时间触发器将查阅这些日历以跳过计划的运行。每个日历都有名称、时区和已排除日期的列表。

大纲

uip or calendars <verb> [options]

动词

动词	用途
list	列出租户中的日历。
get	按键获取一个日历，包括排除的日期。
create	创建具有可选时区的日历。
update	按键对日历进行重命名或重新确定时间区域。
delete	按键删除日历。

所有动词都遵循全局选项（ --output 、 --output-filter 、 --log-level 、 --log-file ）。退出代码遵循标准合同。

uip 或日历列表

列出租户中的所有日历。返回汇总字段（ id 、 name 、 timeZoneId 、 excludedDates和key ）。对于单个日历，请使用calendars get 。

选项

短	长	值	默认	描述
-l	--limit	数字	50	页面大小。
—	--offset	数字	0	跳过计数。
—	--all-fields	标记	关闭	返回完整的 API 有效负载，而不是策划摘要。

示例

uip or calendars list
uip or calendars list --limit 100
uip or calendars list --output-filter 'Data[].{k:key, n:name}'

数据形状（--输出 json）

{
  "Code": "CalendarList",
  "Data": [
    {
      "name": "US Holidays",
      "timeZoneId": "America/New_York",
      "excludedDates": ["2025-07-04", "2025-12-25"],
      "key": "a1b2c3d4-0000-0000-0000-000000000001",
      "id": 1001
    }
  ]
}

UIP 或日历获取

按 GUID 密钥获取日历。返回完整详细信息，包括排除的日期。

参数

名称	必填	用途
<calendar-key>	是	日历键 (GUID)。使用calendars list查找。

选项

短	长	值	默认	描述
—	--all-fields	标记	关闭	返回完整的 API 有效负载，而不是策划摘要。

示例

uip or calendars get a1b2c3d4-0000-0000-0000-000000000001
uip or calendars get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.excludedDates'

数据形状（--输出 json）

{
  "Code": "CalendarGet",
  "Data": {
    "name": "US Holidays",
    "timeZoneId": "America/New_York",
    "excludedDates": ["2025-07-04", "2025-12-25"],
    "key": "a1b2c3d4-0000-0000-0000-000000000001",
    "id": 1001
  }
}

uip 或日历创建

创建新日历。日历是租户作用域。如果省略--time-zone ，则时区默认为 UTC。

参数

名称	必填	用途
<name>	是	日历名称。

选项

短	长	值	默认	描述
—	--time-zone	txt ID	UTC	日历时区（例如Europe/Bucharest ）。

示例

uip or calendars create "EU Holidays" --time-zone "Europe/Bucharest"
uip or calendars create "US Holidays"

数据形状（--输出 json）

{
  "Code": "CalendarCreated",
  "Data": {
    "name": "EU Holidays",
    "timeZoneId": "Europe/Bucharest",
    "excludedDates": [],
    "key": "a1b2c3d4-0000-0000-0000-000000000010",
    "id": 1010
  }
}

备注：

此动词创建具有空excludedDates列表的日历记录。填充排除日期时不会通过 CLI — 直接使用 Orchestrator 用户界面或 API。

uip 或日历更新

通过 GUID 密钥更新日历。系统仅会更改您提供的字段；其余部分保留。

参数

名称	必填	用途
<calendar-key>	是	日历键 (GUID)。

选项

短	长	值	默认	描述
—	--name	text	未更改	新名称。
—	--time-zone	txt ID	未更改	新时区。

示例

uip or calendars update a1b2c3d4-0000-0000-0000-000000000010 \
    --name "EU Public Holidays"

uip or calendars update a1b2c3d4-0000-0000-0000-000000000010 \
    --time-zone "Europe/Berlin"

数据形状（--输出 json）

{
  "Code": "CalendarUpdated",
  "Data": {
    "name": "EU Public Holidays",
    "timeZoneId": "Europe/Bucharest",
    "excludedDates": [],
    "key": "a1b2c3d4-0000-0000-0000-000000000010",
    "id": 1010
  }
}

uip 或日历删除

通过 GUID 密钥删除日历。

参数

名称	必填	用途
<calendar-key>	是	日历键 (GUID)。

选项

短	长	值	默认	描述
-y	--yes	标记	—	必需。确认此不可撤销的操作 — CLI 从不提示。

示例

uip or calendars delete a1b2c3d4-0000-0000-0000-000000000010 --yes

数据形状（--输出 json）

{
  "Code": "CalendarDeleted",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Name": "EU Public Holidays",
    "Status": "Deleted successfully"
  }
}

相关命令

• uip or settings — settings timezones列出对--time-zone有效的时区 ID。

另请参阅

• 全局选项— --output 、 --output-filter 、 --log-level 、 --log-file 。
• 退出代码— 标准退出代码合同。