RetrieveUserSessions - Получить сессии пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

username

Логин пользователя, может быть пустым

^.{1,64}$

Строка до 64-х символов

mac

MAC-адрес пользователя, может быть пустым

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

Значение подходящее под шаблон MAC-адреса, например, aa:bb:cc:dd:ee:ff

apDomain

Домен ТД

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]\{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

startTime

Начало интервала для поиска сессий

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

endTime

Конец интервала для поиска сессий

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

ssidType

Тип сети (Hotspot/Enterprise/Equipment)

^(hotspot|enterprise|equipment)$

hotspot или enterprise

orderType

Тип сортировки (ASC/DESC). По умолчанию ASC

^(ASC|DESC)$

ASC или DESC

count

Количество выводимых записей

^[1-9][0-9]*$

Целое положительное число

offset

Сдвиг от начала списка

^[1-9][0-9]*$

Целое положительное число

queryTotal

Запрашивать ли общее количество записей

^(true|false)$

true или false

Выходные параметры

Параметр Значение Формат значения

items

Список сессий, подходящий под условия запроса

NbiUserSessionItem

total

Общее количество записей

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveUserSessions>
    <nbi:apDomain>root</nbi:apDomain>
    <nbi:startTime>2020-02-29T00:00:00Z</nbi:startTime>
    <nbi:endTime>2020-03-05T00:00:00Z</nbi:endTime>
    <nbi:ssidType>hotspot</nbi:ssidType>
    <nbi:orderType>ASC</nbi:orderType>
    <nbi:count>2</nbi:count>
    <nbi:offset>0</nbi:offset>
    <nbi:queryTotal>true</nbi:queryTotal>
</nbi:RetrieveUserSessions>
Ответ
<ns:RetrieveUserSessionsResponse>
    <ns:return>
        <ax21:code>0</ax21:code>
        <ax21:detail/>
        <ax290:items>
            <ax290:apDomain>toor</ax290:apDomain>
            <ax290:endTime>2020-03-01T00:09:06Z</ax290:endTime>
            <ax290:inputOctets>243860</ax290:inputOctets>
            <ax290:nasIp>10.204.170.160</ax290:nasIp>
            <ax290:nasMac>E0-D9-E3-8E-F4-20</ax290:nasMac>
            <ax290:outputOctets>112041</ax290:outputOctets>
            <ax290:sessionTime>460</ax290:sessionTime>
            <ax290:ssid>Test-Guest</ax290:ssid>
            <ax290:startTime>2020-03-01T00:01:24Z</ax290:startTime>
            <ax290:userIp>100.123.85.14</ax290:userIp>
            <ax290:userMac>F4-AF-E7-C0-45-0A</ax290:userMac>
            <ax290:username>79123456789</ax290:username>
        </ax290:items>
            <ax290:items>
            <ax290:apDomain>toor</ax290:apDomain>
            <ax290:endTime>2020-03-01T00:12:04Z</ax290:endTime>
            <ax290:inputOctets>76421</ax290:inputOctets>
            <ax290:nasIp>10.204.24.186</ax290:nasIp>
            <ax290:nasMac>E0-D9-E3-4E-ED-40</ax290:nasMac>
            <ax290:outputOctets>22631</ax290:outputOctets>
            <ax290:sessionTime>9</ax290:sessionTime>
            <ax290:ssid>Test_Guest_FREE</ax290:ssid>
            <ax290:startTime>2020-03-01T00:11:55Z</ax290:startTime>
            <ax290:userIp>100.64.197.204</ax290:userIp>
            <ax290:userMac>CC-66-0A-A7-74-F9</ax290:userMac>
            <ax290:username>79876543210</ax290:username>
        </ax290:items>
        <ax2104:total>549</ax2104:total>
    </ns:return>
</ns:RetrieveUserSessionsResponse>
Код Описание ошибки

2

Ошибка доступа к БД

63

Некорректный формат поля mac

105

Некорректный формат поля 'startTime'

106

Некорректный формат поля 'endTime'

107

Время старта должно быть раньше времени окончания

436

Не указан обязательный параметр

437

Неверный тип сортировки

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.19-79
Дата публикации 09-06-2021 14:30:17