RetrieveApInfo - Запрос общей информации по Wi-Fi устройствам

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

Команда не поддерживается начиная с версии 1.20

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

Параметр	Значение	Формат значения	Расшифровка формата
domains	Фильтр по доменам. Допускается задавать несколько доменов, разделенных запятыми.	.*	Любой текст
count	Кол-во выводимых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
page	Номер страницы, порции выдаваемых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
orderBy	Поле, определяющее, по какому элементу сортировать выдаваемые данные.	.*	Имя поля, по которому будет выполняться сортировка
orderType	Поле определяющее тип сортировки. (По умолчанию ASC)	^(ASC\|DESC)$	ASC или DESC
filters	Список фильтров, применяемых к результату операции		Объект NbiParameterArray
deviceType	Тип устройства	.*	Текст длиной до 255 символов

Параметр

Значение

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

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

Ссылка

domains

Фильтр по доменам. Допускается задавать несколько доменов, разделенных запятыми.

Любой текст

count

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

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

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

page

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

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

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

orderBy

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

Имя поля, по которому будет выполняться сортировка

orderType

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

^(ASC|DESC)$

ASC или DESC

filters

Список фильтров, применяемых к результату операции

Объект NbiParameterArray

deviceType

Тип устройства

Текст длиной до 255 символов

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

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

Параметр

Значение

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

code

Код ответа

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

detail

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

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

response

Строка

Текст xml ответа

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

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

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>wrong@domain</nbi:domains>
            <nbi:filters></nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>name</nbi:orderBy>
            <nbi:orderType>ACS</nbi:orderType>
            <nbi:deviceType>dev/wifi/ap</nbi:deviceType>
        </nbi:RetrieveApInfo>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:NbiCodeResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.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>8</ax21:code>
                <ax21:detail>Domain 'wrong@domain' does not conform to the rules FQDN</ax21:detail>
                <ax21:response>0</ax21:response>
            </ns:return>
        </ns:NbiCodeResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
408	Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть невложенными.

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>235000047535.VL.RT.root, .VL.RT.root</nbi:domains>
            <nbi:filters>
                <xsd:parameter>
                    <xsd:name></xsd:name>
                    <xsd:value></xsd:value>
                </xsd:parameter>
            </nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
            <nbi:deviceType></nbi:deviceType>
            <nbi:locale></nbi:locale>
        </nbi:RetrieveApInfo>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveApInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                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>408</ax21:code>
                <ax21:detail>All domains from list should be unnested</ax21:detail>
                <ax21:response/>
            </ns:return>
        </ns:RetrieveApInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
407	Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть вложенными

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>.235000047535.VL.RT.root, VL.RT.root</nbi:domains>
            <nbi:filters>
                <xsd:parameter>
                    <xsd:name></xsd:name>
                    <xsd:value></xsd:value>
                </xsd:parameter>
            </nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
            <nbi:deviceType></nbi:deviceType>
            <nbi:locale></nbi:locale>
        </nbi:RetrieveApInfo>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveApInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                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>407</ax21:code>
                <ax21:detail>All domains from list should be nested</ax21:detail>
                <ax21:response/>
            </ns:return>
        </ns:RetrieveApInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>

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

Код

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

Успешно

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>.VL.RT.root</nbi:domains>
            <nbi:filters>
                <xsd:parameter>
                    <xsd:name></xsd:name>
                    <xsd:value></xsd:value>
                </xsd:parameter>
            </nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
            <nbi:deviceType>dev/wifi/ap/eltex/wep/-12ac</nbi:deviceType>
            <nbi:locale></nbi:locale>
        </nbi:RetrieveApInfo>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveApInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiCodeResponse"
                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://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://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">
                <ax23:code>0</ax23:code>
                <ax23:detail/>
                <ax23:response>
                    <![CDATA[
                    <?xml version="1.0" encoding="UTF-8"?><getDeviceList><code>0</code><msg>OK</msg><total>1</total><devices><device><name>192.168.26.223</name><ip>192.168.26.223</ip><type>dev/wifi/ap/eltex/wep/-12ac</type><typeName>WEP-12ac</typeName><domain>12036628.VL.RT.root</domain><state>Пользователи: 1. Принято 998.6 KB, передано 105.7 MB. Скорость средняя 2.0 Kb/s, суммарная 2.0 Kb/s. (27.01.17 10:00)</state><workTime>93433</workTime><fwVersion>1.10.0.81</fwVersion><mac>a8:f9:4b:1f:fc:80</mac><initAddress></initAddress><actNumber></actNumber><users>1</users><recieved>998.6 KB</recieved><transmitted>105.7 MB</transmitted><avgrate>2.0 Kb/s</avgrate><sum>2.0 Kb/s</sum><date>27.01.17 10:00</date></device></devices></getDeviceList>]]>
                </ax23:response>
            </ns:return>
        </ns:RetrieveApInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2635
Дата публикации 12-08-2022 08:29:16