RetrieveNasList2 - Запрос списка точек доступа (AP) из базы RADIUS c использованием фильтров и пагинации

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

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

  2. Команда возвращает спискок точек доступа (AP) из базы RADIUS c использованием фильтров и пагинации.

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

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

search

Не используется

count

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

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

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

page

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

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

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

orderBy

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

id, nasname, shortname, domain, type, ports, secret, server, community, description

Поле в таблице radius.NAS

orderType

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

^(ASC|DESC)$

ASC или DESC

ip

Ip-адрес ТД

^(?:(?: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

Домен ТД

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

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

descr

Описание ТД

.*

Любой текст

name

Имя ТД

.{0,255}$

Любые символы в количестве до 255-ти.

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

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

response

Список точек доступа

Объект NbiNasArray

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveNasList2>
         <nbi:search></nbi:search>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>nasname</nbi:orderBy>
         <nbi:orderType>ACS</nbi:orderType>
         <nbi:ip></nbi:ip>
         <nbi:domain>root</nbi:domain>
         <nbi:descr></nbi:descr>
         <nbi:name></nbi:name>
      </nbi:RetrieveNasList2>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveNasList2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasResponse"
                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>2</ax21:detail>
            <ax21:response xsi:type="ax21:NbiNasArray">
               <ax21:nas xsi:type="ax21:NbiNas">
                  <ax21:descr/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:emsName xsi:nil="true"/>
                  <ax21:id>86</ax21:id>
                  <ax21:ip>1.1.1.1</ax21:ip>
                  <ax21:mac/>
                  <ax21:name>123</ax21:name>
                  <ax21:params xsi:type="ax21:NbiParameterArray"/>
                  <ax21:secret>132546</ax21:secret>
               </ax21:nas>
               <ax21:nas xsi:type="ax21:NbiNas">
                  <ax21:descr/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:emsName xsi:nil="true"/>
                  <ax21:id>87</ax21:id>
                  <ax21:ip>1.1.1.2</ax21:ip>
                  <ax21:mac/>
                  <ax21:name>123</ax21:name>
                  <ax21:params xsi:type="ax21:NbiParameterArray"/>
                  <ax21:secret>123</ax21:secret>
               </ax21:nas>
            </ax21:response>
         </ns:return>
      </ns:RetrieveNasList2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

114

Некорректное значение поля orderBy

8

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

10

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

62

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

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

См. также

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