RetrieveAPListExtended - Запрос списка ТД с информацией по SSID

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

  1. Команда не поддерживается, начиная с версии 1.21

  2. В версии 1.10 команда больше не используется для получения Списка ТД в ЛК. Для обеспечения работоспособности на большом числе точек данные перенесены в БД MySQL eltex_ems.ELTEX_OBJ_GEO, а для выборки добавлена новая команда GetGeoObjectsList.

  3. При обработке запроса NBI обращается в EMS-NBI по URL 'getAPListExtended'.

  4. Использовать команду стоит только в случае крайней необходимости получить оперативные данные EMS, например, состав активных SSID на точке.

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

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

domains

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

.*

Любой текст

count

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

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

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

page

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

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

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

orderBy

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

.*

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

orderType

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

^(ASC|DESC)$

ASC или DESC

filters

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

Объект NbiParameterArray

requestSSIDs

Запрашивать или нет списки SSID ТД

true/false

Текст 'true' или 'false'

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

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

code

Код ответа

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

detail

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

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

response

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

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

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

8

Некорректное значение поля domains
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>wrong@domaint</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>8</ax22:code>
            <ax22:detail>Domain 'wrong@domaint' does not conform to the rules FQDN</ax22:detail>
            <ax220:infos xsi:nil="true"/>
            <ax220:totalCount>0</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

408

Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть невложенными.
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>235000047535.VL.RT.root, .VL.RT.root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>408</ax22:code>
            <ax22:detail>All domains from list should be unnested</ax22:detail>
            <ax220:infos xsi:nil="true"/>
            <ax220:totalCount>0</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

407

Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть вложенными
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>.235000047535.VL.RT.root, VL.RT.root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>407</ax22:code>
            <ax22:detail>All domains from list should be nested</ax22:detail>
            <ax220:infos xsi:nil="true"/>
            <ax220:totalCount>0</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax220:infos xsi:type="ax220:NbiApInfoArray">
               <ax220:infos xsi:type="ax220:NbiApInfo">
                  <ax220:actNumber xsi:nil="true"/>
                  <ax220:building xsi:nil="true"/>
                  <ax220:city xsi:nil="true"/>
                  <ax220:domain xsi:nil="true"/>
                  <ax220:floor xsi:nil="true"/>
                  <ax220:fullName xsi:nil="true"/>
                  <ax220:fwVersion xsi:nil="true"/>
                  <ax220:house xsi:nil="true"/>
                  <ax220:ip>192.168.0.9</ax220:ip>
                  <ax220:mac xsi:nil="true"/>
                  <ax220:name>wep-fake</ax220:name>
                  <ax220:office xsi:nil="true"/>
                  <ax220:ssids xsi:type="ax220:NbiApSSIDInfoArray"/>
                  <ax220:state>Данные не получены. Устройство недоступно с 14.02.2017 19:13:01!</ax220:state>
                  <ax220:street xsi:nil="true"/>
                  <ax220:type>dev/wifi/ap/eltex/wep/-12ac</ax220:type>
                  <ax220:workTime>0</ax220:workTime>
               </ax220:infos>
               <ax220:infos xsi:type="ax220:NbiApInfo">
                  <ax220:actNumber xsi:nil="true"/>
                  <ax220:building>1</ax220:building>
                  <ax220:city>Городище</ax220:city>
                  <ax220:domain xsi:nil="true"/>
                  <ax220:floor>5</ax220:floor>
                  <ax220:fullName>Иванов Иван Иваныч</ax220:fullName>
                  <ax220:fwVersion>1.10.0.110</ax220:fwVersion>
                  <ax220:house>75</ax220:house>
                  <ax220:ip>192.168.15.7</ax220:ip>
                  <ax220:mac>a8:f9:4b:b0:21:60</ax220:mac>
                  <ax220:name>wep-15.7</ax220:name>
                  <ax220:office>501</ax220:office>
                  <ax220:ssids xsi:type="ax220:NbiApSSIDInfoArray">
                     <ax220:SSIDs xsi:type="ax220:NbiApSSIDInfo">
                        <ax220:domain>root</ax220:domain>
                        <ax220:name>_15.7__open</ax220:name>
                        <ax220:portalName>eltex</ax220:portalName>
                        <ax220:portalTariffs>test_port@root,123@root,321@12.root,222@12.root,1112@223.12.root,test_ru@root,test_sdd213@root,12.root@12.root</ax220:portalTariffs>
                        <ax220:security>plainText</ax220:security>
                     </ax220:SSIDs>
                     <ax220:SSIDs xsi:type="ax220:NbiApSSIDInfo">
                        <ax220:domain>root</ax220:domain>
                        <ax220:name>_15.7__enter_5_1</ax220:name>
                        <ax220:portalName xsi:nil="true"/>
                        <ax220:portalTariffs/>
                        <ax220:security>wpaEnterprise</ax220:security>
                     </ax220:SSIDs>
                  </ax220:ssids>
                  <ax220:state>Пользователи: 0. Принято 1,9 GB, передано 2,3 GB. Скорость средняя 0b/s, суммарная 0b/s. (16.02.2017 10:00:00)</ax220:state>
                  <ax220:street>Улицыще</ax220:street>
                  <ax220:type>dev/wifi/ap/eltex/wep/-12ac</ax220:type>
                  <ax220:workTime>1113062</ax220:workTime>
               </ax220:infos>
            </ax220:infos>
            <ax220:totalCount>-1</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

  1. GetGeoObjectsList - Получить список объектов для вкладки Список ТД

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