RetrieveRadiusUserAccountsTimeStatistics - Запрос статистики по учетным записям Wi-Fi клиентов по временному интервалу

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

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

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

Параметр	Значение	Формат значения	Расшифровка формата	Ссылка
username	Фильтр по логину аккаунта Wi-Fi пользователя. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).	.*	Любой текст	Wi-Fi пользователь
domain	Фильтр по домену аккаунта Wi-Fi пользователя. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). Если домен начинается с символа '.' и не использует специальных символов, то статистика будет по всем УЗ для данного домена и его поддоменов.	.*	Любой текст	Domain
timeStart	Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.	.*	Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"
timeEnd	Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.	.*	Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"
count	Кол-во выводимых элементов, обязательно. По запросу count = 0 выдается кол-во всех записей	[0-9]+$	Целое положительное число
page	Номер страницы, порции выдаваемых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
orderBy	Поле, определяющее, по какому элементу сортировать выдаваемые данные.	^(username\|domain)$	username или domain
orderType	Поле определяющее тип сортировки. (По умолчанию ASC)	^(ASC\|DESC)$	ASC или DESC

Параметр

Значение

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

Расшифровка формата

Ссылка

username

Фильтр по логину аккаунта Wi-Fi пользователя. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

Любой текст

Wi-Fi пользователь

domain

Фильтр по домену аккаунта Wi-Fi пользователя. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). Если домен начинается с символа '.' и не использует специальных символов, то статистика будет по всем УЗ для данного домена и его поддоменов.

Любой текст

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

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

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

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

count

Кол-во выводимых элементов, обязательно. По запросу count = 0 выдается кол-во всех записей

[0-9]+$

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

page

Номер страницы, порции выдаваемых элементов, обязательно.

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

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

orderBy

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

^(username|domain)$

username или domain

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

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

Параметр	Значение	Формат значения
code	Код ответа	Целое неотрицательное число.
detail	Пояснение к ответу	Текст английскими буквами с пробелами и спецсимволами.
response	Массив объектов NbiAccountStatistics. Поля inputPacketsDrop, outputPacketsDrop, inputBytesDrop, outputBytesDrop, mac не используются.

Параметр

Значение

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

code

Код ответа

Целое неотрицательное число.

detail

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

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAccountStatistics. Поля inputPacketsDrop, outputPacketsDrop, inputBytesDrop, outputBytesDrop, mac не используются.

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

Код	Описание ошибки
114	Указано некорректное поле сортировки

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>?</nbi:username>
            <nbi:domain>?</nbi:domain>
            <nbi:timeStart></nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>?</nbi:orderBy>
            <nbi:orderType>?</nbi:orderType>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax213:NbiCodeAccountsStatisticsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>114</ax21:code>
                <ax21:detail>Incorrect value of orderBy</ax21:detail>
                <ax213:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
107	Некорректный временной промежуток

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>%</nbi:username>
            <nbi:domain>%</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2007-11-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:count>100</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>username</nbi:orderBy>
            <nbi:orderType>ASC</nbi:orderType>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax213:NbiCodeAccountsStatisticsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>107</ax21:code>
                <ax21:detail>Time start must be before time end.</ax21:detail>
                <ax213:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
0	Успешно

Код

Описание ошибки

Успешно

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountsTimeStatistics>
            <nbi:username>%</nbi:username>
            <nbi:domain>%</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
            <nbi:count>10</nbi:count>
            <nbi:page>22</nbi:page>
            <nbi:orderBy>username</nbi:orderBy>
            <nbi:orderType>ASC</nbi:orderType>
        </nbi:RetrieveRadiusUserAccountsTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountsTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax219:NbiCodeAccountsStatisticsResponse"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax219:response xsi:type="ax219:NbiAccountStatisticsArray">
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets xsi:nil="true"/>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop xsi:nil="true"/>
                        <ax219:outputOctets xsi:nil="true"/>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime xsi:nil="true"/>
                        <ax219:sessionsCount>0</ax219:sessionsCount>
                        <ax219:username>79003544789</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>8387662</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>7814</ax219:outputBytesDrop>
                        <ax219:outputOctets>50492311</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>2732</ax219:sessionTime>
                        <ax219:sessionsCount>5</ax219:sessionsCount>
                        <ax219:username>79003545038</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>7999383</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>209</ax219:outputBytesDrop>
                        <ax219:outputOctets>19461643</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>4951</ax219:sessionTime>
                        <ax219:sessionsCount>9</ax219:sessionsCount>
                        <ax219:username>79003545385</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>1814531</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>43577689</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>531</ax219:sessionTime>
                        <ax219:sessionsCount>4</ax219:sessionsCount>
                        <ax219:username>79003545920</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>73487</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>393558</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>670</ax219:sessionTime>
                        <ax219:sessionsCount>2</ax219:sessionsCount>
                        <ax219:username>79003546820</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>7493754</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>126517821</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>1323</ax219:sessionTime>
                        <ax219:sessionsCount>1</ax219:sessionsCount>
                        <ax219:username>79003548237</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>6401792</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>3185</ax219:outputBytesDrop>
                        <ax219:outputOctets>125952405</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>1710</ax219:sessionTime>
                        <ax219:sessionsCount>3</ax219:sessionsCount>
                        <ax219:username>79003548433</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>4717269</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>2</ax219:outputBytesDrop>
                        <ax219:outputOctets>61893344</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>913</ax219:sessionTime>
                        <ax219:sessionsCount>1</ax219:sessionsCount>
                        <ax219:username>79003548495</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>11439846</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>883</ax219:outputBytesDrop>
                        <ax219:outputOctets>197535662</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>8007</ax219:sessionTime>
                        <ax219:sessionsCount>154</ax219:sessionsCount>
                        <ax219:username>79003549631</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>1677636</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>52415616</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>810</ax219:sessionTime>
                        <ax219:sessionsCount>1</ax219:sessionsCount>
                        <ax219:username>79003549722</ax219:username>
                    </ax219:account>
                    <ax219:summaryInputBytesDrop xsi:nil="true"/>
                    <ax219:summaryInputOctets xsi:nil="true"/>
                    <ax219:summaryInputPacketsDrop xsi:nil="true"/>
                    <ax219:summaryOutputBytesDrop xsi:nil="true"/>
                    <ax219:summaryOutputOctets xsi:nil="true"/>
                    <ax219:summaryOutputPacketLost xsi:nil="true"/>
                    <ax219:summaryOutputPacketsDrop xsi:nil="true"/>
                    <ax219:summarySessionCount xsi:nil="true"/>
                    <ax219:summarySessionTime xsi:nil="true"/>
                    <ax219:totalCount>0</ax219:totalCount>
                </ax219:response>
            </ns:return>
        </ns:RetrieveRadiusUserAccountsTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
0	Успешно

Код

Описание ошибки

Успешно

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountsTimeStatistics>
            <nbi:username>%</nbi:username>
            <nbi:domain>%</nbi:domain>
            <nbi:timeStart></nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
            <nbi:count>0</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserAccountsTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveRadiusUserAccountsTimeStatisticsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax224:NbiCodeAccountsStatisticsResponse"
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax224:response xsi:type="ax224:NbiAccountStatisticsArray">
               <ax224:account xsi:nil="true"/>
               <ax224:summaryInputBytesDrop xsi:nil="true"/>
               <ax224:summaryInputOctets xsi:nil="true"/>
               <ax224:summaryInputPacketsDrop xsi:nil="true"/>
               <ax224:summaryOutputBytesDrop xsi:nil="true"/>
               <ax224:summaryOutputOctets xsi:nil="true"/>
               <ax224:summaryOutputPacketLost xsi:nil="true"/>
               <ax224:summaryOutputPacketsDrop xsi:nil="true"/>
               <ax224:summarySessionCount xsi:nil="true"/>
               <ax224:summarySessionTime xsi:nil="true"/>
               <ax224:totalCount>123</ax224:totalCount>
            </ax224:response>
         </ns:return>
      </ns:RetrieveRadiusUserAccountsTimeStatisticsResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.26-3099
Дата публикации 18-05-2023 06:44:06