Получение конфигурации сессий

Материал из Документация Ключ-АСТРОМ
Версия от 15:10, 22 сентября 2022; RGolovanov (обсуждение | вклад) (Новая страница: «Этот вызов API получает конфигурацию пользовательских сеансов кластера. ==Аутентификация...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Этот вызов API получает конфигурацию пользовательских сеансов кластера.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/clusterConfig/userSessions

Параметры

Для этого вызова API параметры не требуются.

Ответ

Коды ответа

Код Тип Описание
200 UserSessionsConfig Успешно

Объекты тела ответа

Объект 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
  }
}

Пример

В этом примере запрос запрашивает у кластера текущую конфигурацию пользовательских сеансов. Затем кластер возвращает сведения о текущей политике сеансов для одновременных входов и бездействия пользователей. В ответе указано, что ограничение на одновременный вход для пользователей равно 2. Для учетных записей администраторов кластера ограничение равно 5. Кроме того, действует политика выхода из системы без активности, для которой установлено значение 900 секунд.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions" -H  "accept: application/json"

URL-адрес запроса

https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions

Тело ответа

{
  "concurrentSessionPolicyDto": {
    "userLimit": 2,
    "adminLimit": 5
  },
  "automaticLogoutDto": {
    "logoutInactiveUsersEnabled": true,
    "userInactivityTimeout": 900
  }
}

Код ответа

204