GetRadiusCountValue - Возвращает статистику в виде вещественного числа

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

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

  2. Команда возвращает статистику в виде вещественного числа.

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

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

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

apDomain

Домен точки доступа

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

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

Domain

timeStart

Начало временного интервала. Конец временного интервала не может быть раньше этого параметра. Может быть пустым.

.*

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

timeEnd

Конец временного интервала. Начало временного интервала не может быть позже этого параметра. Может быть пустым.

.*

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

action

Действие

TOTAL_UNIQUE_USERS_AT_RADACCT, TOTAL_UNIQUE_USERS_RETURNED, UNIQUE_MACS_AT_RADACCT, TOTAL_TRAFFIC, AVERAGE_SESSION_TRAFFIC, AVERAGE_USER_TRAFFIC_PER_HOUR, AVERAGE_USER_TRAFFIC_PER_DAY, AVERAGE_SESSION_TIME, AVERAGE_USER_TIME_PER_HOUR, AVERAGE_USER_TIME_PER_DAY, TOTAL_USER_MAYBE_RETURN, TOTAL_USER_RETURN, AVERAGE_USER_RETURN_PER_DAY

params

Список параметров

NbiParameterArray

Расшифровка значений типа действия 'action':

  • TOTAL_UNIQUE_USERS_AT_RADACCT - Уникальных пользователей. Используется параметр client_type

  • TOTAL_UNIQUE_USERS_RETURNED - Повторных пользователей. Используются параметры client_type, return_period_s

  • UNIQUE_MACS_AT_RADACCT - Уникальных MAC. Используется параметр client_type

  • TOTAL_TRAFFIC - Суммарный трафик, Б. Используются параметры client_type, traffic_type

  • AVERAGE_SESSION_TRAFFIC - Средний трафик за сессию, Б. Используются параметры client_type, traffic_type

  • AVERAGE_USER_TRAFFIC_PER_HOUR - Средний трафик пользователя в час, Б. Используются параметры client_type, traffic_type

  • AVERAGE_USER_TRAFFIC_PER_DAY - Средний трафик пользователя в день, Б. Используются параметры client_type, traffic_type

  • AVERAGE_SESSION_TIME - Средняя продолжительность сессий. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_HOUR - Среднее время пользователя в сети в час. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_DAY - Среднее время пользователя в сети в день. Используется параметр client_type

  • TOTAL_USER_MAYBE_RETURN - Всего уникальных посещений. Используются параметры client_type, return_period_s

  • TOTAL_USER_RETURN - Всего повторных пользователей. Используются параметры client_type, return_period_s

  • AVERAGE_USER_RETURN_PER_DAY - Среднее число повторных посещений в день. Используются параметры client_type, return_period_s

Список доступных имен параметров выборки 'param':

  • client_type - Тип клиента. Возможные значения: [hotspot|enterprise]

  • traffic_type - Тип трафика. Возможные значения: [in|out]

  • return_period_s - Период повторного посещения. Целое положительное число.

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

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

value

Double

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetRadiusCountValue>
         <nbi:apDomain>root</nbi:apDomain>
         <nbi:timeStart>2015-11-15T22:52:58+03:00</nbi:timeStart>
         <nbi:timeEnd>2017-11-15T22:52:58+03:00</nbi:timeEnd>
         <nbi:action>TOTAL_UNIQUE_USERS_AT_RADACCT</nbi:action>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>client_type</xsd:name>
               <xsd:value>enterprise</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetRadiusCountValue>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetRadiusCountValueResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiDoubleValueResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax210:value>3.0</ax210:value>
         </ns:return>
      </ns:GetRadiusCountValueResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

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

62

Указанный домен не зарегистрирован

281

Не найден один из параметров запроса

419

Некорректный параметр запроса 'function'

Пример использования

См. также

Вернуться к списку команд
Версия 1.21-2344
Дата публикации 22-12-2021 05:34:48