RetrieveHotspotAccessLists - Получить списки пользователей с учетом фильтрации и пагинации

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

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

  2. Команда для получения белых или черных списков пользователей или и тех и других.

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

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

filter

текст фильтра

domain

Домен

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

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

Domain

count

количество возвращаемых записей

page

номер страницы (пачки записей)

orderBy

сортировать по этому полю

orderType

тип сортировки (ASC|DESC)

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

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

usersListArray

Массив объектов NbiHotspotAccessList со списками

NbiHotspotAccessListArray

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
          <nbi:RetrieveHotspotAccessLists>
           <nbi:filter>1</nbi:filter>
           <nbi:domain>.root</nbi:domain>
           <nbi:count>10</nbi:count>
           <nbi:page>1</nbi:page>
           <nbi:orderBy>list_type</nbi:orderBy>
           <nbi:orderType></nbi:orderType>
        </nbi:RetrieveHotspotAccessLists>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveHotspotAccessListsResponse>
                 <ns:return>
                    <ax21:code>0</ax21:code>
                    <ax21:detail>2</ax21:detail>
                    <ax248:profiles>
                       <ax248:profiles>
                          <ax248:domain>root</ax248:domain>
                          <ax248:idList>
                             <ax242:str>?</ax242:str>
                          </ax248:idList>
                          <ax248:listType>WHITE</ax248:listType>
                          <ax248:name>1</ax248:name>
                       </ax248:profiles>
                       <ax248:profiles>
                          <ax248:domain>notroot.root</ax248:domain>
                          <ax248:idList>
                             <ax242:str>aa:aa:aa:aa:aa:11</ax242:str>
                          </ax248:idList>
                          <ax248:listType>WHITE</ax248:listType>
                          <ax248:name>1</ax248:name>
                       </ax248:profiles>
                    </ax248:profiles>
                 </ns:return>
              </ns:RetrieveHotspotAccessListsResponse>
           </soapenv:Body>
        </soapenv:Envelope>
Код Описание ошибки

112

Значение поля count должно быть целым и положительным числом

113

Значение поля page должно быть целым и положительным числом

427

Списка с таким именем не существует

10

У роли нет прав создавать список с указанным доменом

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

См. также

Вернуться к списку команд
Версия 1.21-2362
Дата публикации 17-01-2022 09:09:34