RetrieveSSIDListV3 - Получить список SSID (имя, домен) с пагинацией

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

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

  2. Основная задача команды - ускорить выдачу списка SSID за счет поддержки пагинации и ограничения возможностей фильтрации и сортировки.

  3. Сортировка постоянная - по имени SSID в алфавитном порядке.

  4. Запросы к БД работают только с таблицей MySQL wireless.SSID, потому фильтрация доступна только по полям, содержащимся в этой таблице. Все значения параметров фильтрации должны передаваться типом строка.

Доступные параметры фильтрации:

  • name - префикс имени SSID;

  • domain_name - домен SSID. Если начинается с точки - учитывать все вложенные; если нет - выдать SSID только с точным совпадением по домену;

  • status - Статус SSID 0 (Operational), 1 (Locked);

  • security - Тип безопасности 1 (Plain text), 3 (WPA Personal), 5 (WPA Enterprise);

  • ssidtype - Тип SSID 0 (Hotspot), 1 (Enterprise), 2 (Equipment).

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

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

skip

Число записей, которые нужно пропустить

Integer

count

Число записей, которые нужно вернуть. Если 0 - только вернуть значение total.

Integer

params

Дополнительные параметры фильтрации (имя, значение строкой)

NbiParameter

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

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

items

Список элементов. Может быть пустым

NbiNameDomain

total

Общее число элементов, удовлетворяющих запросу

long

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<nbi:RetrieveSSIDListV3>
         <nbi:skip>0</nbi:skip>
         <nbi:count>2</nbi:count>
         <nbi:params>
            <xsd:name>name</xsd:name>
            <xsd:value>auto</xsd:value>
         </nbi:params>
         <nbi:params>
            <xsd:name>ssidtype</xsd:name>
            <xsd:value>0</xsd:value>
         </nbi:params>
</nbi:RetrieveSSIDListV3>
Ответ
      <ns:RetrieveSSIDListV3Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:items xsi:type="ax21:NbiNameDomain">
               <ax21:domain>root</ax21:domain>
               <ax21:name>autocreate0</ax21:name>
            </ax21:items>
            <ax21:items xsi:type="ax21:NbiNameDomain">
               <ax21:domain>root</ax21:domain>
               <ax21:name>autocreate1</ax21:name>
            </ax21:items>
            <ax21:total>0</ax21:total>
         </ns:return>
      </ns:RetrieveSSIDListV3Response>
Код Описание ошибки

2

Ошибка доступа к БД

8

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

10

Нет прав на домен, указанный в дополнительных параметрах

281

Несовместимый тип одного из параметров запроса

312

Некорректное значение одного из дополнительных параметров запроса

999

Системная ошибка

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

См. также

Вернуться к списку команд
Версия 1.24-2769
Дата публикации 18-10-2022 03:26:05