RetrieveDomainsIntegralStatusV3 - Получить интегральный статус узлов дерева объектов

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

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

  2. Используется в ЛК для отображения статуса регионов, площадок.

  3. Основное отличие от версии V2 - возможность запросить статистику сразу для нескольких доменов.

  4. Если список доменов (domains) оставить пустым (не указывать вообще), будет получен интегральный статус узлов дерева для всех доменов роли.

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

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

domains

Список доменов, для которых будет получен интегральный статус

String

Список доменов для поиска. Пустой список будет означать запрос по всем доменам роли

nested

Вложенность доменов

Boolean

true - включая дочерние домены, false - без дочерних доменов. Если не указать параметр, по умолчанию будет true

count

Число записей, он же limit.

Integer

0, чтобы получить количество записей, подходящих под условия запроса

skip

Пропустить N записей с начала

Integer

filters

NbiParameterArray Список фильтров

На данный момент фильтры не поддерживаются

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

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

domains

Список данных по узлам

NbiDomainIntegralStatus

totalSize

Общее число записей, удовлетворяющих условиям фильтрации

int

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomainsIntegralStatusV3>
         <nbi:domains>building-1.root</nbi:domains>
         <nbi:domains>building-2.root</nbi:domains>
         <nbi:nested>true</nbi:nested>
         <nbi:count>10</nbi:count>
         <nbi:skip>0</nbi:skip>
      </nbi:RetrieveDomainsIntegralStatusV3>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveDomainsIntegralStatusV3Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax215:domains>
               <ax215:domainName>floor-0.building-2.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>4</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-4.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-2.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-1.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>5</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-5.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>1</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-1.building-2.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>0</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>6</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-4.building-2.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>15</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-0.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>2</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-3.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:totalSize>0</ax215:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusV3Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

62

Данный домен не зарегистрирован в системе SoftWLC

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

См. также

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