RetrieveRadiusUserAcctData2 - Запрос данных аккаунтинга для Wi-Fi пользователя по имени, nas-ip и домену

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

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

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

Параметр	Значение	Формат значения	Расшифровка формата	Ссылка
userName	Имя устройства Wi-Fi пользователя.	^.{1,64}$	Текст до 64-х символов.	Wi-Fi пользователь
nasIp	NAS ip-адрес устройства Wi-Fi пользователя.	^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$	4 целых числа в диапазоне [0…255] разделенных точкой.
domain	Домен устройства Wi-Fi пользователя.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN	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	Кол-во выводимых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
page	Номер страницы, порции выдаваемых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
orderBy	Поле, определяющее, по какому элементу сортировать выдаваемые данные.	.*	username, domain, tariffCode или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)
orderType	Поле определяющее тип сортировки. (По умолчанию ASC)	^(ASC\|DESC)$	ASC или DESC

Параметр

Значение

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

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

Ссылка

userName

Имя устройства Wi-Fi пользователя.

^.{1,64}$

Текст до 64-х символов.

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

nasIp

NAS ip-адрес устройства Wi-Fi пользователя.

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…255] разделенных точкой.

domain

Домен устройства Wi-Fi пользователя.

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

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

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

Кол-во выводимых элементов, обязательно.

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

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

page

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

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

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

orderBy

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

username, domain, tariffCode или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)

orderType

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

^(ASC|DESC)$

ASC или DESC

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

Параметр	Значение	Формат значения
code	Код ответа	Целое неотрицательное число.
detail	Пояснение к ответу	Текст английскими буквами с пробелами и спецсимволами.
response	Массив объектов NbiAcct, объект NbiAcct с суммарными данными, общее число записей

Параметр

Значение

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

code

Код ответа

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

detail

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

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

response

Массив объектов NbiAcct, объект NbiAcct с суммарными данными, общее число записей

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

Код	Описание ошибки
104	Некорректное значение поля nasIp

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData2>
            <xsd:userName>name1</xsd:userName>
            <xsd:nasIp>192.12.3</xsd:nasIp>
            <xsd:domain>root</xsd:domain>
            <xsd:timeStart></xsd:timeStart>
            <xsd:timeEnd></xsd:timeEnd>
            <nbi:count></nbi:count>
            <nbi:page></nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </xsd:RetrieveRadiusUserAcctData2>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse2
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>104</ns:code>
                <ns:detail>Illegal value '192.12.3' for field 'nasIp'!</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse2>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
107	Некорректный временной период. timeStart больше timeEnd

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData2>
            <xsd:userName>name1</xsd:userName>
            <xsd:nasIp>192.12.3.4</xsd:nasIp>
            <xsd:domain>root</xsd:domain>
            <xsd:timeStart>2014-12-01T00:00:00+03:00</xsd:timeStart>
            <xsd:timeEnd>2014-11-01T00:00:00+03:00</xsd:timeEnd>
            <nbi:count></nbi:count>
            <nbi:page></nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </xsd:RetrieveRadiusUserAcctData2>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse2
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>107</ns:code>
                <ns:detail>Incorrect time period. Time start must be before time end.</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse2>
    </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:RetrieveRadiusUserAcctData2>
            <nbi:domain></nbi:domain>
            <nbi:timeStart>2016-01-14T16:46:35</nbi:timeStart>
            <nbi:timeEnd>2016-03-15T16:46:35</nbi:timeEnd>
            <nbi:count>3</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserAcctData2>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctData2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeAcctSummaryResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="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:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail>3 items from 3893</ax21:detail>
                <ax21:response xsi:type="ax21:NbiAcctArraySummary">
                    <ax21:acct xsi:type="ax21:NbiAcct">
                        <ax21:authentic>Local</ax21:authentic>
                        <ax21:connectionInfoStart>CONNECT 0Mbps 802.11g</ax21:connectionInfoStart>
                        <ax21:connectionInfoStop>CONNECT 0Mbps 802.11g</ax21:connectionInfoStop>
                        <ax21:domain/>
                        <ax21:framedAddress/>
                        <ax21:framedProtocol/>
                        <ax21:groupname/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>7088</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP>192.168.203.243</ax21:nasIP>
                        <ax21:nasMac>A8-F9-4B-B1-64-21:Rostelecom for Rosbank</ax21:nasMac>
                        <ax21:nasPortId>0</ax21:nasPortId>
                        <ax21:nasPortType>Wireless-802.11</ax21:nasPortType>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>3627</ax21:outputOctets>
                        <ax21:outputPacketLost>0</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm/>
                        <ax21:serviceType/>
                        <ax21:sessionId>02E124C7-5C7A8854</ax21:sessionId>
                        <ax21:sessionTime>50</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime>2016-02-15T14:15:14.000+06:00</ax21:startTime>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime>2016-02-15T14:16:04.000+06:00</ax21:stopTime>
                        <ax21:terminateCause>User-Request</ax21:terminateCause>
                        <ax21:uniqueId>41c0e5c87c1eafbf</ax21:uniqueId>
                        <ax21:userMAC>00-01-DA-FD-AD-C7</ax21:userMAC>
                        <ax21:username>0001dafdadc7</ax21:username>
                        <ax21:xascendSessionSvrKey/>
                    </ax21:acct>
                    <ax21:acct xsi:type="ax21:NbiAcct">
                        <ax21:authentic>Local</ax21:authentic>
                        <ax21:connectionInfoStart>CONNECT 0Mbps 802.11g</ax21:connectionInfoStart>
                        <ax21:connectionInfoStop>CONNECT 0Mbps 802.11g</ax21:connectionInfoStop>
                        <ax21:domain/>
                        <ax21:framedAddress/>
                        <ax21:framedProtocol/>
                        <ax21:groupname/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>8322</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP>192.168.207.59</ax21:nasIP>
                        <ax21:nasMac>A8-F9-4B-B3-0A-E1:Welcome to Sberbank Rostelecom</ax21:nasMac>
                        <ax21:nasPortId>0</ax21:nasPortId>
                        <ax21:nasPortType>Wireless-802.11</ax21:nasPortType>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>4579</ax21:outputOctets>
                        <ax21:outputPacketLost>3</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm/>
                        <ax21:serviceType/>
                        <ax21:sessionId>5BD58A03-14636E26</ax21:sessionId>
                        <ax21:sessionTime>39</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime>2016-02-09T18:40:12.000+06:00</ax21:startTime>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime>2016-02-09T18:40:51.000+06:00</ax21:stopTime>
                        <ax21:terminateCause>User-Request</ax21:terminateCause>
                        <ax21:uniqueId>e1d4e7355a7d26fe</ax21:uniqueId>
                        <ax21:userMAC>00-03-AA-E3-DB-E1</ax21:userMAC>
                        <ax21:username>0003aae3dbe1</ax21:username>
                        <ax21:xascendSessionSvrKey/>
                    </ax21:acct>
                    <ax21:acct xsi:type="ax21:NbiAcct">
                        <ax21:authentic>Local</ax21:authentic>
                        <ax21:connectionInfoStart>CONNECT 0Mbps 802.11g</ax21:connectionInfoStart>
                        <ax21:connectionInfoStop>CONNECT 0Mbps 802.11g</ax21:connectionInfoStop>
                        <ax21:domain/>
                        <ax21:framedAddress/>
                        <ax21:framedProtocol/>
                        <ax21:groupname/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>2935</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP>192.168.207.59</ax21:nasIP>
                        <ax21:nasMac>A8-F9-4B-B3-0A-E1:Welcome to Sberbank Rostelecom</ax21:nasMac>
                        <ax21:nasPortId>0</ax21:nasPortId>
                        <ax21:nasPortType>Wireless-802.11</ax21:nasPortType>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>2502</ax21:outputOctets>
                        <ax21:outputPacketLost>2</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm/>
                        <ax21:serviceType/>
                        <ax21:sessionId>7E4CA96B-7F6A3F86</ax21:sessionId>
                        <ax21:sessionTime>15</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime>2016-02-09T18:45:15.000+06:00</ax21:startTime>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime>2016-02-09T18:45:30.000+06:00</ax21:stopTime>
                        <ax21:terminateCause>User-Request</ax21:terminateCause>
                        <ax21:uniqueId>56553180b5e4ee49</ax21:uniqueId>
                        <ax21:userMAC>00-03-AA-E3-DB-E1</ax21:userMAC>
                        <ax21:username>0003aae3dbe1</ax21:username>
                        <ax21:xascendSessionSvrKey/>
                    </ax21:acct>
                    <ax21:summary xsi:type="ax21:NbiAcct">
                        <ax21:authentic xsi:nil="true"/>
                        <ax21:connectionInfoStart xsi:nil="true"/>
                        <ax21:connectionInfoStop xsi:nil="true"/>
                        <ax21:domain xsi:nil="true"/>
                        <ax21:framedAddress xsi:nil="true"/>
                        <ax21:framedProtocol xsi:nil="true"/>
                        <ax21:groupname xsi:nil="true"/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>58348250</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP xsi:nil="true"/>
                        <ax21:nasMac xsi:nil="true"/>
                        <ax21:nasPortId xsi:nil="true"/>
                        <ax21:nasPortType xsi:nil="true"/>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>63189776</ax21:outputOctets>
                        <ax21:outputPacketLost>91102</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm xsi:nil="true"/>
                        <ax21:serviceType xsi:nil="true"/>
                        <ax21:sessionId xsi:nil="true"/>
                        <ax21:sessionTime>513401215</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime xsi:nil="true"/>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime xsi:nil="true"/>
                        <ax21:terminateCause xsi:nil="true"/>
                        <ax21:uniqueId xsi:nil="true"/>
                        <ax21:userMAC xsi:nil="true"/>
                        <ax21:username xsi:nil="true"/>
                        <ax21:xascendSessionSvrKey xsi:nil="true"/>
                    </ax21:summary>
                    <ax21:totalCount>3893</ax21:totalCount>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserAcctData2Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2695
Дата публикации 02-09-2022 11:42:18