RetrieveApGraphic - Получить RRD статистику в виде графика

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

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

  2. Предназначена для получения графика RRD статистики в ЛК. Изображение создается на сервере EMS, и передается в NBI, ЛК в base64 кодировке.

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

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

domains

Домены разделенные запятой. Могут быть null.

String

emsObjId

ID устройства, для которого получаем RRD статистику

Integer

code

Код статистики

String

users - число клиентов на точке доступа
uplink_load - загрузка аплинка
ping - опрос доступности

dataView

Тип графика: min, max (по умолчанию), avg…​

String

timePeriod

Диапазон, в сек, от текущего времени.

Integer

subtype

Дополнительный параметр для ping: snmp, icmp.

String

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

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

response

Ответ EMS-NBI в виде XML.

String

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveApGraphic>
         <nbi:domains>root</nbi:domains>
         <nbi:emsObjId>13</nbi:emsObjId>
         <nbi:code>ping</nbi:code>
         <nbi:dataView>min</nbi:dataView>
         <nbi:timePeriod>36000</nbi:timePeriod>
         <nbi:subtype>icmp</nbi:subtype>
      </nbi:RetrieveApGraphic>
Ответ
----      <ns:RetrieveApGraphicResponse>
             <ns:return>
                <ax22:code>0</ax22:code>
                <ax22:detail/>
                <ax22:response><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
    <getApGraphic>
    <code>0</code>
    <msg>OK</msg>
    <base64>bla-bla-bla</base64>
    </getApGraphic>]]></ax22:response>
             </ns:return>
          </ns:RetrieveApGraphicResponse>
----
Код Описание ошибки

3

Ошибка взаимодействия с EMS-NBI

8

Некорректный формат домен

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

281

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

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

См. также

Вернуться к списку команд
Версия 1.21-2344
Дата публикации 22-12-2021 05:34:48