RetrieveAPDomainTimeStatistics - Запрос статистики по "географическим" доменам ТД
Общая информация
-
Команда актуальна, начиная с версии 1.20
-
Команда позволяет получить статистику по аккаунтингу для "географических" доменов ТД. На вход команде подается домен или домен с поддоменами (для этого указывается точка '.' перед доменом), для которого требуется получить статистику. Результатом выполнения запроса, в случае включения поддоменов, будет oбогащенный статистическими данными домен и непосредственные дети этого домена типа 'both' или 'ap'. В ином случае - только обогащенный статистическими данными домен.
-
В случае включения поддоменов значения статистики для домена рассчитываются как сумма соответствующих значений для этого домена и всех его поддоменов. В противном случае значения статистики рассчитываются без учета поддоменов.
-
Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата | Ссылка |
|---|---|---|---|---|
domain |
Домен, для которого запрашивается статистика. Если домен начинается с '.', то в результат запроса включается статистика только по поддоменам первого уровня. В нее включаются только домены типа 'both' или 'ap'. |
(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$) |
Текст длиной до 235 символов, удовлетворяющий правилам FQDN. |
Domain |
timeStart |
Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым. |
.* |
Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00" |
|
timeEnd |
Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым. |
.* |
Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00" |
|
ssid |
Имя и домен SSID. Объект NbiNameDomain. |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
code |
Код ответа |
Целое неотрицательное число. |
detail |
Пояснение к ответу |
Текст английскими буквами с пробелами и спецсимволами. |
response |
Массив объектов NbiApDomainStatistics |
Примеры команд и кодов
| Код | Описание ошибки |
|---|---|
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:RetrieveAPDomainTimeStatistics>
<nbi:domain>.root</nbi:domain>
<nbi:timeStart>2020-03-10T22:52:58+03:00</nbi:timeStart>
<nbi:timeEnd>2020-03-15T22:52:58+03:00</nbi:timeEnd>
<nbi:ssid>
<xsd:name>name</xsd:name>
<xsd:domain>root</xsd:domain>
</nbi:ssid>
</nbi:RetrieveAPDomainTimeStatistics>
</soapenv:Body>
</soapenv:Envelope>Ответ
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveAPDomainTimeStatisticsResponse xmlns:ns="http://nbi.radius.eltex.org">
<ns:return xsi:type="ax21:NbiCodeApDomainStatisticsResponse">
<ax21:code>0</ax21:code>
<ax21:detail>Success</ax21:detail>
<ax21:response xsi:type="ax21:NbiApDomainStatisticsArray">
<ax21:statistics xsi:type="ax21:NbiApDomainStatistics">
<ax23:apCount>1</ax23:apCount>
<ax23:connections>902</ax23:connections>
<ax23:domain>root</ax23:domain>
<ax23:inputOctets>477626368000</ax23:inputOctets>
<ax23:leaf xsi:type="ax23:NbiApDomainStatistics">
<ax23:apCount>1</ax23:apCount>
<ax23:connections>3</ax23:connections>
<ax23:domain>rt.root</ax23:domain>
<ax23:inputOctets>1572864000</ax23:inputOctets>
<ax23:leaf xsi:nil="true"/>
<ax23:lostPackets>150</ax23:lostPackets>
<ax23:outputOctets>3145728000</ax23:outputOctets>
<ax23:peakConnections xsi:nil="true"/>
<ax23:peakTime xsi:nil="true"/>
<ax23:uniqueAccount>3</ax23:uniqueAccount>
<ax23:uniqueMAC>3</ax23:uniqueMAC>
</ax23:leaf>
<ax23:leaf xsi:type="ax23:NbiApDomainStatistics">
<ax23:apCount>1</ax23:apCount>
<ax23:connections>2</ax23:connections>
<ax23:domain>Ap.root</ax23:domain>
<ax23:inputOctets>4194304000</ax23:inputOctets>
<ax23:leaf xsi:nil="true"/>
<ax23:lostPackets>100</ax23:lostPackets>
<ax23:outputOctets>8388608000</ax23:outputOctets>
<ax23:peakConnections xsi:nil="true"/>
<ax23:peakTime xsi:nil="true"/>
<ax23:uniqueAccount>1</ax23:uniqueAccount>
<ax23:uniqueMAC>1</ax23:uniqueMAC>
</ax23:leaf>
<ax23:leaf xsi:type="ax23:NbiApDomainStatistics">
<ax23:apCount>0</ax23:apCount>
<ax23:connections>0</ax23:connections>
<ax23:domain>Er.root</ax23:domain>
<ax23:inputOctets>0</ax23:inputOctets>
<ax23:leaf xsi:nil="true"/>
<ax23:lostPackets>0</ax23:lostPackets>
<ax23:outputOctets>0</ax23:outputOctets>
<ax23:peakConnections xsi:nil="true"/>
<ax23:peakTime xsi:nil="true"/>
<ax23:uniqueAccount>0</ax23:uniqueAccount>
<ax23:uniqueMAC>0</ax23:uniqueMAC>
</ax23:leaf>
<ax23:lostPackets>45100</ax23:lostPackets>
<ax23:outputOctets>955252736000</ax23:outputOctets>
<ax23:peakConnections xsi:nil="true"/>
<ax23:peakTime xsi:nil="true"/>
<ax23:uniqueAccount>890</ax23:uniqueAccount>
<ax23:uniqueMAC>889</ax23:uniqueMAC>
</ax21:statistics>
</ax21:response>
</ns:return>
</ns:RetrieveAPDomainTimeStatisticsResponse>
</soapenv:Body>
</soapenv:Envelope>| Код | Описание ошибки |
|---|---|
2 |
Ошибка обращения к БД MySQL |
7 |
Не указан домен |
8 |
Домен не удовлетворяет правилам FQDN |
10 |
Пользователь не имеет прав на данный домен или домен SSID |
16 |
SSID не существует |
62 |
Домен для поиска или домен SSID не зарегистрирован в системе |
107 |
Домен не удовлетворяет правилам FQDN |
227 |
Имя SSID не удовлетворяет требованиям |
281 |
Неверный параметр в запросе |
477 |
Выполнение запроса заняло слишком много времени. Требуется выбрать домен нижнего уровня, с меньшим количеством точек доступа |
См. также
Вернуться к списку команд
Версия 1.26-3099
Дата публикации 18-05-2023 06:44:06