API device
Раздел API ERP "UserSide"
Назначение: Оборудование
Дополнительные параметры: action - подкатегория запроса (возможное значение: см.ниже)
Подкатегории
add_mark
Изменено в 3.19beta1 (параметр object_type исключен)
Описание: Добавление метки Обязательные параметры: object_type - Тип устройства [switch] (до версии 3.19beta1) object_id - id устройства mark_id - ID метки
get_connected_ont_information
Добавлено в: 3.14.13
Описание: Получение информации о подключенных ONU к OLT (сохраненная информация из базы. Прямой опрос не выполняется) Необязательные параметры: device_id - ID OLT (можно через запятую) level_onu_rx_min - минимальный входящий уровень сигнала на ONU (выбрать записи с уровнем менее чем...) level_onu_rx_max - максимальный входящий уровень сигнала на ONU (выбрать записи с уровнем выше чем...)
get_current_ont_data
Добавлено с: 3.16dev4
Описание: Получение некоторой текущей информации по ONU с OLT Обязательные параметры: id - id устройства (ONU)
get_device_id
Изменено в 3.19beta1 (параметр object_type исключен)
Доработано в: 3.13.63 (в data_typer добавлено возможное значение serial_number)
Доработано в: 3.12.95 (в data_typer добавлено возможное значение mac)
Описание: Получение ID устройства по входящим данным Обязательные параметры: object_type - тип устройства [switch] (до версии 3.19beta1) data_typer - тип данных, которые проверяем (возможные значения: ip, mac, inventory_number, serial_number, additional_field_XXX) data_value - значение
get_data
Доработано в 3.19.15 (добавлен параметр customer_id)
Доработано в 3.19beta1 (добавлен параметр dataset)
Доработано в: 3.18.4 (добавлен параметр is_hide_access_data)
Доработано в: 3.17beta1 (добавлен параметр node_id)
Доработано в: 3.15.18 (добавлен object_type=olt)
Доработано в: 3.14.14 (добавлен параметр is_hide_ifaces_data)
Доработано в: 3.12.38 (добавлен object_type=all)
Описание: Получение информации об устройствах Обязательные параметры: object_type - Тип устройства [switch|onu|olt|radio|all] Необязательные параметры: customer_id - id абонента (можно через запятую) dataset - список полей, которые выводить в выдаче (через запятую) is_online - флаг - выбирать только активные устройства (1 - активные, -1 - неактивные) is_hide_ifaces_data - флаг - скрывать развёрнутую информацию по интерфейсам оборудования is_hide_access_data - флаг - скрывать информацию по параметрам доступа к оборудованию node_id - id сооружения связи (можно через запятую) object_id - id объекта для выборки
get_iface_info
Добавлено с: 3.17dev1
Описание: Получение текущей информации по интерфейсам (напрямую с устройства) Обязательные параметры: id - id устройства
get_iface_mac
Изменено в 3.19beta1 (параметр object_type исключен)
Добавлено с: 3.12beta25
Описание: Список интерфейсов с MAC-адресами на устройстве Обязательные параметры: object_type - Тип устройства [switch] (до версии 3.19beta1) object_id - id устройства для выборки
get_mac_list
Изменено в 3.19beta1 (параметр object_type исключен, список object_id сделан необязательным)
Описание: Получение списка MAC-адресов, которые были найдены на устройстве Обязательные параметры: object_type - Тип устройства [switch] (до версии 3.19beta1) Необязательные параметры: interface_list - Номер интерфейса по которому выводить список (можно через запятую) object_id - id устройства для выборки
get_ont_data
Доработано в: 3.16dev4 (добавлен параметр device_id)
Добавлено с: 3.12.81
Описание: Получение последней информации по ONU Обязательные параметры: id - MAC-адрес или серийный номер (id) или device_id - id устройства (ONU)
get_pon_level_history
Доработано в: 3.16.19 (добавлен параметр onu_device_id)
Доработано в: 3.16dev4 (добавлен параметр device_id)
Доработано в: 3.12.60 (добавлены параметры limit, order_by, is_desc)
Добавлено с: 3.12.53
Описание: Получение истории PON-уровней сигналов по ONU Обязательные параметры: onu_name - MAC-адрес или серийный номер ONU (без разделителей) или device_id - id устройства (OLT) или onu_device_id - id устройства (ONU) Необязательные параметры: limit - ограничение списка выводимых данных order_by - поле сортировки данных is_desc - флаг - сортировка в обратном порядке
get_relation_customers
Добавлено в: 3.19.45
Описание: Получение информации о зависимых абонентах Обязательные параметры: device_id - id устройства Необязательные параметры: port_start - начальный номер порта port_finish - конечный номер порта
delete_mark
Изменено в 3.19beta1 (параметр object_type исключен)
Описание: Снятие метки Обязательные параметры: object_type - Тип устройства [switch] (до версии 3.19beta1) object_id - id устройства mark_id - ID метки
read_fdb
Добавлено с: 3.15.7
Описание: Чтение FDB-таблицы с устройства (может выполняться продолжительное время) Обязательные параметры: device_id - id устройства
set_data
Изменено в 3.19beta1 (параметр object_type исключен)
Доработано в 3.17dev1 (в параметр param добавлено возможное значение date_last_activity)
Доработано в 3.14.53 (в параметр param добавлено возможное значение downlink_port, uplink_port)
Доработано в 3.13.61 (в параметр param добавлено возможное значение iface_count)
Доработано в 3.12.74 (в параметр param добавлено возможное значение comment)
Описание: Изменение информации об устройстве Обязательные параметры: object_type - Тип устройства [switch] (до версии 3.19beta1) object_id - id устройства param - тип параметра для изменения [ip|mac|comment|iface_count|downlink_port|uplink_port|date_last_activity] value - данные (может быть пустым)
set_iface_state
Добавлено с: 3.15beta3
Описание: Изменение состояния интерфейса на устройстве Обязательные параметры: device_id - id устройства iface - номер интерфейса state - состояние [1|0]
find_mac
Добавлено с: 3.12beta25
Описание: Поиск MAC-адреса в истории опроса по оборудованию Обязательные параметры: mac - MAC-адрес (верхний регистр без разделителей)