В данном разделе приводится описание команд, которые используются для настройки контроля активности сессий на Web API.

Таблица 1 — Описание параметров контроля активности сессий.

Название	Значение по умолчанию	Возможные значения	Описание
check_activity	true	undefined - не задана (настройка не влияет на поведение web api) false - выключена true - включена, дефолтое значение.	Проверка активности сессий на web api
init_websocket_idle_timeout	undefined	undefined - не задана, дефолтное значение (настройка не влияет на поведение web api) от 60 до 3600 сек	Время жизни сессии на web api. Продлевается, если в сессии была активность (был запрос от клиента).
session_lifetime	undefined	undefined - выключен. от 1 до 3600 секунд.	Таймер активности после создания вебсокета на web api. Если в заданный интервал времени в вебсокете не было активности, то он будет закрыт.

clean

Данной командой осуществляется установка параметров по умолчанию для контроля активности сессий.

Путь команды:

/cluster/core/<CORE>/web-api/clean

Синтаксис:

clean [<Field>] [--force]

Параметры:

<FIELD> — название параметра, значение которого нужно установить по умолчанию, список параметров приведен в таблице 1;

--force — выполнение команды без запроса подтверждения.

Пример:

/cluster/core/core1/web-api/clean       
[clean] You are going to clean all customized properties.
Are you sure?: yes/no ?> yes
Properties values successfully restored

или


/cluster/core/core1/web-api/clean --force
Properties values successfully restored


или


/cluster/core/core1/web-api/clean check_activity
Property "check_activity" values successfully restored

info

Данной командой производится просмотр свойств параметров контроля активности сессий.

Путь команды:

/cluster/core/<CORE>/web-api/info

Синтаксис:

info [<Field>]

Параметры:

<FIELD> — название параметра, значение которого нужно посмотреть, список параметров приведен в таблице 1.

Пример:

/cluster/core/core1/web-api/info                
┌───────────────────────────┬─────────┐
│         Property          │  Value  │
├───────────────────────────┼─────────┤
│check_activity             │true     │
│init_websocket_idle_timeout│undefined│
│session_lifetime           │undefined│
└───────────────────────────┴─────────┘

или

/cluster/core/core1/web-api/info check_activity
┌──────────────┬─────┐
│   Property   │Value│
├──────────────┼─────┤
│check_activity│true │
└──────────────┴─────┘

set

Данной командой производится изменение параметров контроля активности сессий.

Путь команды:

cluster/core/<CORE>/web-api/set

Синтаксис:

set <Field> <Value>

Параметры:

<FIELD> — название параметра, значение которого требуется изменить, список параметров приведен в таблице 1.
<VALUE> — новое значение свойства, возможные значения приведены в таблице 1.

Пример:

/cluster/core/core1/web-api/set init_websocket_idle_timeout 10           
Property "init_websocket_idle_timeout" successfully changed from: 
undefined
   to
10.