RetrieveDomainSsidTypeStatistic - Получить статистику по трафику для одного домена по типу сети

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

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

  2. Команда позволяет получить статистику по входящему трафику в байтах, исходящему трафику в байтах, числу уникальных МАС-адресов, числу уникальных логинов пользователей, группировка выполняется по типам SSID.

  3. Параметр apDomain является обязательным для заполнения. Если значение параметров startTime и endTime не задано, то endTime вычисляется как текущее время, а startTime равно значению endTime минус 30 дней. Если только значение параметра startTime не задано, то startTime равно значению endTime минус 30 дней. Если только значение параметра endTime не задано, то endTime равно значению startTime плюс 30 дней.

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

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

apDomain

Домен ТД

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

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

startTime

Начало интервала для поиска статистики

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

endTime

Конец интервала для поиска статистики

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

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

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

code

Код ответа

int

detail

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

String

items

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

NbiDomainSsidTypeStatisticItem

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

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveDomainSsidTypeStatistic>
         <nbi:apDomain>root</nbi:apDomain>
         <nbi:startTime>2020-01-10T00:00:00Z</nbi:startTime>
         <nbi:endTime>2020-02-10T03:59:59Z</nbi:endTime>
      </nbi:RetrieveDomainSsidTypeStatistic>
Ответ
   <soapenv:Body>
      <ns:RetrieveDomainSsidTypeStatisticResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail>Success</ax22:detail>
            <ax2116:items xsi:type="ax2116:NbiDomainSsidTypeStatisticItem">
               <ax2116:countUnicLogin>1</ax2116:countUnicLogin>
               <ax2116:countUnicMac>1</ax2116:countUnicMac>
               <ax2116:inputOctets>2608226</ax2116:inputOctets>
               <ax2116:outputOctets>1170461</ax2116:outputOctets>
               <ax2116:ssidType>0</ax2116:ssidType>
            </ax2116:items>
            <ax2116:items xsi:type="ax2116:NbiDomainSsidTypeStatisticItem">
               <ax2116:countUnicLogin>204</ax2116:countUnicLogin>
               <ax2116:countUnicMac>64</ax2116:countUnicMac>
               <ax2116:inputOctets>557984303478</ax2116:inputOctets>
               <ax2116:outputOctets>317731214287</ax2116:outputOctets>
               <ax2116:ssidType>1</ax2116:ssidType>
            </ax2116:items>
         </ns:return>
      </ns:RetrieveDomainSsidTypeStatisticResponse>
Код Описание ошибки

2

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

8

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

62

Несуществующий домен

105

Некорректный формат поля 'startTime'

106

Некорректный формат поля 'endTime'

107

Время старта должно быть раньше времени окончания

281

Параметр запроса не указан или пуст

436

Не указан обязательный параметр

999

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

См. также

Вернуться к списку команд
Версия 1.19-48
Дата публикации 15-03-2021 16:55:34