Обновление конфигурации сессий
Этот вызов API обновляет конфигурацию пользовательских сеансов кластера. Вы можете изменить конфигурацию сеансов пользователей, указав новые ограничения на одновременные сеансы пользователей для учетных записей администратора кластера и обычных пользователей.
Установите ограничения на 0
для неограниченного количества одновременных пользовательских сеансов. Если вы решите установить любое из ограничений равным 0
, ограничение для другого типа учетной записи также должно быть установлено равным 0
.
Вы можете использовать этот запрос для обновления политики автоматического выхода из системы. По умолчанию автоматический выход пользователей, которые остаются на автоматически обновляемой странице, не предусмотрен. Используйте приведенную ниже полезную нагрузку, чтобы включить автоматический выход из системы и установить время ожидания сеанса на 900 секунд (15 минут):
"automaticLogoutDto": {
"logoutInactiveUsersEnabled": true,
"userInactivityTimeout": 900
}
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI)
, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/cluster/v2/clusterConfig/userSessions
Параметры
Параметр | Тип | Описание | В | Обязательно |
---|---|---|---|---|
body | UserSessionsConfig | Конфигурация пользовательских сессий - политика одновременных сессий и автоматический выход из системы. | body | Нет |
Объекты тела запроса
Объект UserSessionsConfig
Элемент | Тип | Описание |
---|---|---|
concurrentSessionPolicyDto | ConcurrentSessionPolicy | Конфигурация политики одновременных сеансов. Установите «0», чтобы отключить ограничение сеанса. |
automaticLogoutDto | AutomaticLogoutConfiguration | Настройка автоматического выхода. |
Объект ConcurrentSessionPolicy
Элемент | Тип | Описание |
---|---|---|
userLimit | integer | Ограничение сеанса для обычных пользователей (0 = без ограничений) |
adminLimit | integer | Ограничение сеанса для пользователей с правами администратора (0 = без ограничений) |
Объект AutomaticLogoutConfiguration
Элемент | Тип | Описание |
---|---|---|
logoutInactiveUsersEnabled | boolean | True, если включен автоматический выход |
userInactivityTimeout | integer | Тайм-аут бездействия пользователя |
JSON-модель тела запроса
{
"concurrentSessionPolicyDto": {
"userLimit": 1,
"adminLimit": 1
},
"automaticLogoutDto": {
"logoutInactiveUsersEnabled": true,
"userInactivityTimeout": 900
}
}
Ответ
Коды ответа
Код | Описание |
---|---|
200 | Успешно |
400 | Неверные параметры |
510 | Ошибка обновления конфигурации |
Пример
В этом примере запрос обновляет конфигурацию пользовательских сеансов кластера. Кластер обновляет текущую политику сеансов для одновременных входов и бездействия пользователей. Запрос указывает, что ограничение на одновременный вход для пользователей составляет 3
. Ограничение для учетных записей администратора кластера — 5
. Кроме того, действует политика выхода из системы без активности, для которой установлено значение 900
секунд.
Curl
curl -X PUT "https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions" -H "accept: */*" -H "Content-Type: */*" -d "{\"concurrentSessionPolicyDto\":{\"userLimit\":0,\"adminLimit\":0},\"automaticLogoutDto\":{\"logoutInactiveUsersEnabled\":true,\"userInactivityTimeout\":900}}"
URL-адрес запроса
https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions
Тело запроса
{
"concurrentSessionPolicyDto": {
"userLimit": 3,
"adminLimit": 5
},
"automaticLogoutDto": {
"logoutInactiveUsersEnabled": true,
"userInactivityTimeout": 900
}
}
Код ответа
204