GetTopActiveUsers - Получить список самых активных пользователей

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

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

  2. Допустимые поля для упорядочивания выборки

    • octets_total - Суммарное число входящего и исходящего трафика в байтах

    • octets_in - Входящий трафик в байтах

    • octets_out - Исходящий трафик в байтах

    • octets_total_avg - Среднее число суммарного входящего и исходящего трафика (байт/сек)

    • octets_in_avg - Среднее число входящего трафика (байт/сек)

    • octets_out_avg - Среднее число исходящего трафика (байт/сек)

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

  4. Начиная с версии 1.17 исключен входной параметр deactivated. Поэтому полученные пользователи больше не будет содержать значения в полях deactivated, deactivationUntil, family, name, lastVisit, tariffName

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

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

startTime

Время старта отрезка для поиска активности. Опциональный параметр.

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

endTime

Время конца отрезка для поиска активности. Опциональный параметр.

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

deactivated

Deprecated. Включение в результат только деактивированных либо деактивированных пользователей. Опциональный параметр.

true либо false

orderBy

Поле, по которому следует выполнять упорядовачивание

См. раздел Общая информация (п.2)

APDomain

Домен ТД

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

offset

Смещение относительно начала выборки

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

count

Кол-во записей выборки

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

userCategories

Категория пользователя (1 и более повторений)

Возможные значения: hotspot,enterprise

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

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

total

Общее число найденных пользователей

long

usersArray

Объект со списком пользователей NbiTopActiveUsersArray

NbiTopActiveUsersArray

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetTopActiveUsers>
         <nbi:orderBy>octets_total</nbi:orderBy>
         <nbi:offset>0</nbi:offset>
         <nbi:count>1</nbi:count>
         <nbi:userCategories>enterprise</nbi:userCategories>
      </nbi:GetTopActiveUsers>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetTopActiveUsersResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax261:total>31</ax261:total>
            <ax261:usersArray xsi:type="ax261:NbiTopActiveUsersArray">
               <ax261:users xsi:type="ax261:NbiActiveUser">
                  <ax261:deactivated/>
                  <ax261:deactivationUntil/>
                  <ax261:domain>toor.esirpretne</ax261:domain>
                  <ax261:family/>
                  <ax261:lastVisit/>
                  <ax261:name/>
                  <ax261:octetsIn>6820471925</ax261:octetsIn>
                  <ax261:octetsInAvg>1996.23014934</ax261:octetsInAvg>
                  <ax261:octetsOut>49177979219</ax261:octetsOut>
                  <ax261:octetsOutAvg>10432.16958253</ax261:octetsOutAvg>
                  <ax261:octetsTotal>55998451144</ax261:octetsTotal>
                  <ax261:octetsTotalAvg>12428.39973187</ax261:octetsTotalAvg>
                  <ax261:tariffName/>
                  <ax261:username>vladimir.shishmarev</ax261:username>
               </ax261:users>
            </ax261:usersArray>
         </ns:return>
      </ns:GetTopActiveUsersResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

454

Недопустимое значение флага деактивации

455

Некорректный список категорий пользователя

Вернуться к списку команд
Версия 1.19-67
Дата публикации 07-05-2021 17:25:19