RetrieveRadiusAcctData – Запрос данных аккаунтинга для Wi-Fi пользователей

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

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

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

Параметр	Значение	Формат значения	Расшифровка формата	Ссылка
username	Логин пользователя Wi-Fi. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.	.*	Любой текст. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).	Wi-Fi пользователь
domain	Поле для поиска по домену пользователя. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]\{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN.	Domain
userMac	Поле для поиска по MAC-адресу пользователя. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.	.*	6 двузначных шестнадцатеричных чисел, разделенных ':' или '-'. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).
nasIp	Поле для поиска по IP-адресу точки доступа. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.	.*	4 целых числа в диапазоне [0…255] разделенных точкой. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).	AP
workTime	Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Может быть пустым. Хотя бы одно поле поиска должно присутствовать.	.*	Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"
nasDomain	Поле для поиска по домену точки доступа. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.	(?=^.{0,235}$)(^(?:(?!\d+\.\|-)[a-zA-Z0-9_\-]\{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN.	AP

Параметр

Значение

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

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

Ссылка

username

Логин пользователя Wi-Fi. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

Любой текст. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).

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

domain

Поле для поиска по домену пользователя. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

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

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

Domain

userMac

Поле для поиска по MAC-адресу пользователя. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

6 двузначных шестнадцатеричных чисел, разделенных ':' или '-'. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).

nasIp

Поле для поиска по IP-адресу точки доступа. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

4 целых числа в диапазоне [0…255] разделенных точкой. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).

workTime

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

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

nasDomain

Поле для поиска по домену точки доступа. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

(?=^.{0,235}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]\{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$)

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

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

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

Параметр

Значение

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

code

Код ответа

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

detail

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

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

response

Массив объектов NbiAcct

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

Код	Описание ошибки
10	Домен роли не имеет прав на домен

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username></xsd:username>
            <xsd:domain>wifi</xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
62	Домен не зарегистрирован

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username></xsd:username>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
29	Все поля для поиска пусты

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username></xsd:username>
            <xsd:domain></xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>29</ns:code>
                <ns:detail>All fields for search is empty!</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>

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

Код

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

Успешно

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username>andrey</xsd:username>
            <xsd:domain>root</xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:acct>
                        <ns:authentic>RADIUS</ns:authentic>
                        <ns:connectionInfoStart>CONNECT 0Mbps 802.11g</ns:connectionInfoStart>
                        <ns:connectionInfoStop>CONNECT 0Mbps 802.11g</ns:connectionInfoStop>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:framedAddress>192.168.41.25</ns:framedAddress>
                        <ns:framedProtocol/>
                        <ns:groupname/>
                        <ns:inputBytesDrop>0</ns:inputBytesDrop>
                        <ns:inputOctets>117432</ns:inputOctets>
                        <ns:inputPacketsDrop>0</ns:inputPacketsDrop>
                        <ns:nasDomain>root</ns:nasDomain>
                        <ns:nasIP>192.168.40.30</ns:nasIP>
                        <ns:nasMac>A8-F9-4B-B0-04-80:Eltex-Local</ns:nasMac>
                        <ns:nasPortId>0</ns:nasPortId>
                        <ns:nasPortType>Wireless-802.11</ns:nasPortType>
                        <ns:nasSecret>eltex</ns:nasSecret>
                        <ns:outputBytesDrop>0</ns:outputBytesDrop>
                        <ns:outputOctets>186991</ns:outputOctets>
                        <ns:outputPacketLost>0</ns:outputPacketLost>
                        <ns:outputPacketsDrop>0</ns:outputPacketsDrop>
                        <ns:realm>enterprise</ns:realm>
                        <ns:serviceType/>
                        <ns:sessionId>1A049FB9-5830074B</ns:sessionId>
                        <ns:sessionTime>67</ns:sessionTime>
                        <ns:startDelay>0</ns:startDelay>
                        <ns:startTime>2015-05-21T16:35:44.000+07:00</ns:startTime>
                        <ns:stopDelay>0</ns:stopDelay>
                        <ns:stopTime>2015-05-21T17:35:44.000+07:00</ns:stopTime>
                        <ns:terminateCause/>
                        <ns:uniqueId>6cd7f5179d688aa2</ns:uniqueId>
                        <ns:userMAC>74-DE-2B-FD-59-D9</ns:userMAC>
                        <ns:username>andrey</ns:username>
                        <ns:xascendSessionSvrKey/>
                    </ns:acct>
                </ns:response>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.20-2055
Дата публикации 13-08-2021 02:44:15