Просмотр и закрытие веб-сессий

Содержание

Обзор
Запросы

Обзор

Отображает открытые веб-сессии и позоволяет их принудительно закрывать разными запросами.

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`GET`	`/rest/v1/master/logicalroles/ws/sessions`	Получение списка открытых веб-сессий.
`POST`	`/rest/v1/master/logicalroles/ws/sessions`	Закрытие всех веб-сессий пользователя в домене
`DELETE`	`/rest/v1/master/logicalroles/ws/sessions/<session_id>`	Закрытие одной веб-сессии

GET

/rest/v1/master/logicalroles/ws/sessions

Получение списка открытых веб-сессий.

POST

/rest/v1/master/logicalroles/ws/sessions

Закрытие всех веб-сессий пользователя в домене

DELETE

/rest/v1/master/logicalroles/ws/sessions/<session_id>

Закрытие одной веб-сессии

Общие параметры запросов

Приведенные параметры передаются в части query string URL (?param=value) для запросов GET и DELETE, а в случае запроса POST - в теле запроса. Параметры применяются для ограничения зоны применения запроса. Являются опциональными и могут отсутствовать.

Table 1. Возможные параметры
Имя	Тип	Описание
`sites`	`json<str> или json<list<str>>`	Список имён сайтов либо строка с одним из специальных значений в формате JSON. Например `["SITE1","SITE3"]` или `"all"` (все сайты) или `"current"` (текущий сайт, значение по-умолчанию).

Получение списка открытых веб-сессий.

Возвращает список открытых веб-сессий на текущем сайте либо на сайте(-ах) указанных в запросе.

Запрос

Дополнительные параметры отсутствуют. Применяется только общий фильтр по сайтам.

Пример запроса

GET /rest/v1/master/master/logicalroles/ws/sessions?sites=["SITE1"] HTTP/1.1

Ответ

Содержит список открытых веб-сессий.

Table 2. Поля объектов
Имя	Описание
`connections`	Активные `websocket` подключения (только для сессий, где `session_type` = `webdocket`).
`domain`	Домен веб-сессии.
`login`	Логин пользователя веб-сессии в домене.
`session_id`	Идентификатор веб-сессии.
`session_type`	Тип веб-сессии.
`site`	Сайт веб-сессии.
`ttl`	Оставшееся время жизни веб-сессии в сек.
`user_id`	Идентификатор пользователя веб-сессии в домене.

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "domain": "master.domain",
    "login": "curl",
    "session_id": "a1cd9a88-0176-9a15-d1c0-e0d55e0cd303",
    "session_type": "http",
    "site": "central",
    "ttl": 43187,
    "user_id": "32328e08-016c-f61d-4ef4-e0d55e0cd303"
  },
  {
    "domain": "master.domain",
    "login": "adminma",
    "session_id": "0f274f6b-0176-99e4-5ca7-e0d55e0cd303",
    "session_type": "http",
    "site": "central",
    "ttl": 39946,
    "user_id": "37eca732-016d-2962-dbfa-e0d55e0cd303"
  },
  {
    "domain": "master.domain",
    "login": "adminma",
    "session_id": "16d72c4c-0176-99e7-5545-e0d55e0cd303",
    "session_type": "http",
    "site": "central",
    "ttl": 40141,
    "user_id": "37eca732-016d-2962-dbfa-e0d55e0cd303"
  },
  {
    "connections": [
      {
        "conn_id": "5476d54a-0176-9a16-92a0-e0d55e0cd303",
        "is_pid_alive": true,
        "node": "ws1@192.168.0.32",
        "pid": "<0.11647.54>"
      }
    ],
    "domain": "master.domain",
    "login": "adminma",
    "session_id": "16d72c4c-0176-99e7-5545-e0d55e0cd303",
    "session_type": "websocket",
    "site": "central",
    "ttl": 40141,
    "user_id": "37eca732-016d-2962-dbfa-e0d55e0cd303"
  }
]

Закрытие всех веб-сессий пользователя в домене

Закрывает все веб-сессии пользователя в домене кроме сессии используемой в запросе.

Запрос

Запрос может содержать дополнительные параметры зоны действия.

Table 3. Поля объекта
Имя	Тип	Описание
`action`	`str`	Действие. Поле должно содержать значение `"logout"`.
`domain`	`str`	Домен для закрытия сессий.
`user`	`str`	Пользователь для закрытия сессий. Принимается либо `id`, либо `login` сущности user

Пример запроса

POST /rest/v1/master/logicalroles/ws/sessions HTTP/1.1
Content-Type: application/json; charset=utf-8

{
  "action": "logout",
  "domain": "master.domain",
  "user": "admin",
  "sites": "all"
}

Ответ

Содержит статус выполнения запроса.

Table 4. Поля объектов
Имя	Описание
`status`	Текст "logged out all sessions but current".

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "status": "logged out all sessions but current"
}

Закрытие одной веб-сессии

Закрывает веб-сессию с указанным идентификатором.

Запрос

Запрос может содержать дополнительные параметры зоны действия.

Пример запроса

DELETE /rest/v1/master/logicalroles/ws/sessions/51e6cad2-0176-8f8e-a432-e0d55e0cd303?sites="all" HTTP/1.1

Ответ

Пример ответа

HTTP/1.1 204 No Content