檢視次數:
該 API 提供對許多 Server & Workload Security保護 系統設定的訪問。它對於在部署後立即自動化配置非常有用。
您使用以下 SDK 類別與系統設定互動：
  • SystemSettings：定義所有可用系統設定的屬性。這些屬性以其對應的系統設定命名。系統設定列表，請參閱設定參考中的 系統設定。
  • SettingValue：儲存單一字串值。使用 SettingValue 物件來儲存 SystemSettings 屬性的值，這些屬性是 SettingValue 類型。
  • SystemSettingsApi：使您能列出和修改Server & Workload Security保護上的系統設定（使用SystemSettings物件），並獲取、修改和重置特定系統設定的值。

檢索、修改或重置單一系統設定 上層主題

當您處理一個或少量系統設定時，請使用 SystemSettingsApi 類別中提供存取單一系統設定的方法或函數：
  • 要檢索設定或將其重置為預設值，請建立SystemSettingsApi類別並使用describeSystemSetting或resetSystemSetting方法或函數。將設定名稱作為參數包含在內。（請參閱系統設定以獲取設定列表。）
  • 要修改設定，請建立一個 SystemSettingsApi 類別並使用 modifySystemSetting 方法或函數，並將設定名稱和設定值作為參數。該值是一個 SettingValue 物件。
要修改系統設定，您需要設定的名稱和包含所需值的SettingValue物件。請注意，SettingValue物件的值是一個String：
# value for platform_setting_agent_initiated_activation_enabled
allow_value = api.SettingValue()
allow_value.value = str(allow)
然後，使用 SystemSettingsApi 物件來修改設定：
system_settings_api = api.SystemSettingsApi(api.ApiClient(configuration))

return system_settings_api.modify_system_setting(api.SystemSettings.platform_setting_agent_initiated_activation_enabled, allow_value, api_version)

修改單一系統設定 上層主題

以下範例設定控制是否允許代理啟動激活的系統設定值。
檢視來源
# Create the setting value
allow_value = api.SettingValue()
allow_value.value = str(allow)

# Modify system setting on Server & Workload Security保護
system_settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return system_settings_api.modify_system_setting(api.SystemSettings.platform_setting_agent_initiated_activation_enabled, allow_value, api_version)
另請參閱 API 參考中的 修改系統設定 操作。

列出或修改多個系統設定 上層主題

當您處理許多系統設定時，請使用 SystemSettingsApi 類別的方法或函數，這些方法或函數可在一次呼叫中存取所有系統設定：
  • listSystemSettings：返回一個 SystemSettings 物件，其中包含在 Server & Workload Security保護 上設定的所有系統設定值。
  • modifySystemSettings: 根據作為參數提供的 SystemSettings 物件修改所有系統設定。
使用以下一般步驟來使用 SDK 修改系統設定：

步驟

  1. 為您正在配置的每個系統設置創建一個SettingValue對象。將每個對象的值設置為您希望的相應系統設置的值。
  2. 建立一個 SystemSettings 物件並將屬性設置為 SettingValue 物件。
  3. 創建一個SystemSettingsApi對象，並使用它根據SystemSettings對象修改Server & Workload Security保護上的系統設置。

接下來需執行的動作

SettingValue 值的類型為字串。以下範例創建了一個 SettingValue，用於將設定值設為 100：
max_sessions = api.SettingValue()
max_sessions.value = "100"
使用 SettingValue 作為設定的值：
system_settings = api.SystemSettings()
system_settings.platform_setting_active_sessions_max_num = max_sessions
最後，修改 Server & Workload Security保護 上的設定：
settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return settings_api.modify_system_settings(system_settings, api_version)

修改多個系統設定 上層主題

以下範例設定了兩個系統設定：控制使用者可建立的最大會話數的系統設定，以及當超過最大值時管理員採取的動作。
檢視來源
# Create the SettingValue object and set the max sessions value
max_sessions = api.SettingValue()
max_sessions.value = str(max_allowed)

# Add the SettingValue object to a SystemSettings object
system_settings = api.SystemSettings()
system_settings.platform_setting_active_sessions_max_num = max_sessions

# Repeat for the platform_setting_active_sessions_max_exceeded_action
exceed_action = api.SettingValue()
exceed_action.value = action
system_settings.platform_setting_active_sessions_max_exceeded_action = exceed_action

# Modify system settings on Server & Workload Security保護
settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return settings_api.modify_system_settings(system_settings, api_version)
另請參閱 API 參考中的 修改系統設定 操作。有關驗證 API 呼叫的資訊，請參閱 [使用 Server & Workload Security保護 進行驗證](../api-send-request/#authenticate)