UIP 或设置

uip or settings用于读取和写入租户级别的 Orchestrator 设置。设置是按点分前缀（ Abp.Timing.* 、 Alerts.Email.* 、 Auth.* 、 Scalability.* 、 Triggers.*等）组织的键值对。使用settings list发现密钥，使用settings get / update读取或更改单个值， settings execution用于结构化执行设置配置（显示名称和允许的值），使用settings timezones列出有效的时区 ID 。

大纲

uip or settings <verb> [options]

动词

动词	用途
list	列出租户设置。
get	按键读取一个设置。
update	按键写入一个设置。
execution	获取执行设置配置（全局或机器人作用域）。
timezones	列出可用的时区 ID。

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

常见设置键

以下类别并非详尽无遗 — 使用settings list发现一切。

• 常规： Abp.Timing.TimeZone （时区 ID — 运行settings timezones以列出有效 ID）、 Abp.Localization.DefaultLanguageName （例如en 、 fr 、 de ）。
• 电子邮件警示： Alerts.Email.Enabled 、 Abp.Net.Mail.Smtp.Host 、 .Port 、 .UserName 、 .Password 、 .EnableSsl 、 .UseDefaultCredentials 、 Abp.Net.Mail.DefaultFromAddress 。
• 机器人安全性： Auth.Robot.EnforceAuthenticationToken 、 Auth.UnattendedRobot.ForceClientCredentials 、 AttendedRobot.RunDisconnectedHours （整数； 0禁用）。
• 部署： DeploymentUrl 、 NuGet.Packages.ApiKey 、 Deployment.Libraries.Url 、 NuGet.Activities.ApiKey 、 Deployment.Processes.AuthenticationType （ Secure / apiKey ）。
• 可扩展性： Scalability.SignalR.Enabled 、 Scalability.SignalR.Transport （位掩码： 1 WebSockets、 2 SSE、 4长轮询、 7全部）、 Scalability.Heartbeat.PeriodSeconds （默认30 ）、 Scalability.Heartbeat.FailureThreshold （默认4 ）。
• 触发器： Triggers.DisableWhenFailedCount （默认10 ）、 Triggers.DisableWhenFailingSinceDays （默认1 ）、 Triggers.JobsCountStrategy （ PERPROCESS / PERTRIGGER ）、 QueueTrigger.ActivationFrequencyInMinutes （默认30 ）、 ConnectedTriggers.AutoDisableJobFailuresThreshold （默认5 ）。
• 队列： inProgressMaxNumberOfMinutes （默认1440 = 24 小时）。
• 作业： Jobs.TerminatingJobsTimeout （默认1440分钟 = 24 小时）。

UIP 或设置列表

列出租户设置。可以选择按作用域进行筛选。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。
—	--scope	枚举	—	Application、 Tenant 、 User 、 All 。
-l	--limit	数字	100	页面大小。
—	--offset	数字	0	跳过计数。

示例

uip or settings list
uip or settings list --scope Tenant --limit 200
uip or settings list --output-filter 'Data[].name'

数据形状（--输出 json）

{
  "Code": "SettingsList",
  "Data": [
    { "name": "Abp.Timing.TimeZone", "value": "UTC", "id": "Abp.Timing.TimeZone" },
    { "name": "Alerts.Email.Enabled", "value": "true", "id": "Alerts.Email.Enabled" }
  ]
}

UIP 或设置获取

按键读取一个设置。

参数

名称	必填	用途
<key>	是	设置键（例如Abp.Timing.TimeZone ）。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。

示例

uip or settings get Abp.Timing.TimeZone
uip or settings get Alerts.Email.Enabled --output-filter 'Data.Value'

数据形状（--输出 json）

{
  "Code": "SettingsGet",
  "Data": {
    "Key": "Abp.Timing.TimeZone",
    "Value": "UTC"
  }
}

UIP 或设置更新

按键写入一个设置。

参数

名称	必填	用途
<key>	是	设置键。
<value>	是	新值（字符串；适用服务器端验证）。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。

示例

uip or settings update Abp.Timing.TimeZone Europe/Bucharest
uip or settings update Alerts.Email.Enabled true

数据形状（--输出 json）

{
  "Code": "SettingsUpdated",
  "Data": {
    "Key": "Abp.Timing.TimeZone",
    "Value": "Europe/Bucharest",
    "Status": "Updated successfully"
  }
}

UIP 或设置执行

获取全局 ( 0 ) 或机器人 ( 1 ) 作用域的结构化执行设置配置。每个条目都包含显示名称、值类型（ Boolean 、 MultipleChoice等）、默认值以及允许值的列表（适用于选项类型）。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。
—	--scope	0 或者 1	0	“设置作用域”：全局 ( 0 ) 或机器人 ( 1 )。

示例

# Global execution settings
uip or settings execution

# Robot-scoped execution settings
uip or settings execution --scope 1

# Just the keys and their allowed values
uip or settings execution \
    --output-filter 'Data._configuration[].{k:key, vals:possibleValues}'

数据形状（--输出 json）

{
  "Code": "ExecutionSettings",
  "Data": {
    "scope": "Global",
    "_configuration": [
      {
        "key": "TracingLevel",
        "displayName": "Logging Level",
        "valueType": "MultipleChoice",
        "defaultValue": "Information",
        "possibleValues": [
          "Verbose", "Trace", "Information", "Warning", "Error", "Critical", "Off"
        ]
      },
      {
        "key": "LoginToConsole",
        "displayName": "Login To Console",
        "valueType": "Boolean",
        "defaultValue": "true",
        "possibleValues": []
      }
    ]
  }
}

uip 或时区设置

列出 Orchestrator 可识别的时区 ID。这些是Abp.Timing.TimeZone和--time-zone中的uip or calendars的有效值。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。

示例

uip or settings timezones
uip or settings timezones --output-filter 'Data[].value'

数据形状（--输出 json）

{
  "Code": "TimezoneList",
  "Data": [
    { "name": "(UTC) Coordinated Universal Time", "value": "UTC" },
    { "name": "(UTC+02:00) Bucharest", "value": "GTB Standard Time" }
  ]
}

相关命令

• uip or calendars — --time-zone值来自settings timezones 。
• uip or audit-logs — 使用--component Settings筛选以查看设置更改。

另请参阅

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