RetrieveTimeStatistic - Запрос статистики для отображения на графике или в таблице

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

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

  2. Команда служит для получения статистики, отображаемой на графике или в таблице.

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

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

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

function

Типы статистики

SESSTIME_RADIUS_STAT, TRAFFIC_RADIUS_STAT, TRAFFIC_RADIUS_STAT_DASHBOARD, TRAFFIC_RADIUS_STAT_DASHBOARD_STRICT, USER_RADIUS_STAT, USER_RADIUS_PRESENT, CLIENT_RADIUS_PRESENT, COMMON_RADIUS_STATISTIC, TOTAL_ONLINE_USERS_TIME_STAT, TOTAL_CREATED_USERS_TIME_STAT, TOTAL_UPDATED_USERS_TIME_STAT, TOTAL_SESSION_TIME_STAT, TOTAL_TRAFFIC_TIME_STAT, TOTAL_USER_RETURN_TIME_STAT, TOTAL_AUTH_TYPE_TIME_STAT

params

Параметры выборки

NbiParameterArray

locale

Локаль

"ru", "ru_RU", "en", "en_GB" …​

Текст произвольной длины

Расшифровка значений типа функции 'function':

  • SESSTIME_RADIUS_STAT - Статистика продолжительности сесcий. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TRAFFIC_RADIUS_STAT - Статистика пользовательского трафика. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TRAFFIC_RADIUS_STAT_DASHBOARD - Статистика трафика с укороченными названями рядов и без учёта неавторизованных пользователей для отображения в dashboard. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TRAFFIC_RADIUS_STAT_DASHBOARD_STRICT - Статистика трафика с укороченными названями рядов и без учёта неавторизованных пользователей для отображения в dashboard. Возвращается трафик точно в указанных временнЫх границах.. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • USER_RADIUS_STAT - Статистика количества подключений. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • USER_RADIUS_PRESENT - Статистика количества пользователей. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • CLIENT_RADIUS_PRESENT - Статистика количества клиентов. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • COMMON_RADIUS_STATISTIC - Статистика количества пользовательских устройств. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

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

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

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

  • TOTAL_SESSION_TIME_STAT - Суммарно сессий. Используются параметры: filter_ap_domain, client_type.

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

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

  • TOTAL_AUTH_TYPE_TIME_STAT - Статистика по типам авторизации из radstat. Используются параметры: filter_ap_domain, client_type.

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

  • from - Время начала сбора статистики в формате «yyyy-MM-dd HH:mm:ss».

  • to - Время окончания сбора статистики в формате «yyyy-MM-dd HH:mm:ss».

  • step - Шаг графика.

  • filter_ssid - Имя SSID-а.

  • filter_user - Имя пользователя.

  • filter_nas_ip - IP-адрес NAS.

  • filter_ap_domain - Домен точки доступа.

  • filter_ap_id - Идентификатор точки доступа.

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

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

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

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

response

Объект NbiRadiusStatisticArray

NbiRadiusStatisticArray

statistic

Текстовое представление статистики

String

title

Описание собранной статистики

String

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:RetrieveTimeStatistic>
                 <nbi:function>SESSTIME_RADIUS_STAT</nbi:function>
                 <nbi:params>
                    <xsd:parameter>
                       <xsd:name>from</xsd:name>
                       <xsd:value>2015-12-24 07:31:28</xsd:value>
                    </xsd:parameter>
                    <xsd:parameter>
                       <xsd:name>to</xsd:name>
                       <xsd:value>2017-12-31 07:31:29</xsd:value>
                    </xsd:parameter>
                 </nbi:params>
                 <nbi:locale>ru_RU</nbi:locale>
              </nbi:RetrieveTimeStatistic>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTimeStatisticResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusTimeStatisticResponce"
                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/>
                <ax21:response xsi:type="ax21:NbiRadiusStatisticArray">
                   <ax21:item xsi:type="ax21:NbiRadiusStatisticItemArray">
                      <ax21:item xsi:type="ax21:NbiRadiusItemGraphArray">
                         <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                            <ax21:name>Среднее время сессии, сек</ax21:name>
                            <ax21:value>0.0</ax21:value>
                         </ax21:item>
                      </ax21:item>
                      <ax21:time>1450917088000</ax21:time>
                   </ax21:item>
                   <ax21:item xsi:type="ax21:NbiRadiusStatisticItemArray">
                      <ax21:item xsi:type="ax21:NbiRadiusItemGraphArray">
                         <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                            <ax21:name>Среднее время сессии, сек</ax21:name>
                            <ax21:value>0.0</ax21:value>
                         </ax21:item>
                      </ax21:item>
                      <ax21:time>1451421600000</ax21:time>
                   </ax21:item>
                </ax21:response>
                <ax21:statistic xsi:nil="true"/>
                <ax21:title>Среднее время сессий</ax21:title>
             </ns:return>
          </ns:RetrieveTimeStatisticResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

419

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

107

Начало временного интервала не должно превышать конец временного интервала.

7

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

8

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

10

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

62

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

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

См. также

Вернуться к списку команд
Версия 1.26-3053
Дата публикации 31-03-2023 06:03:06