maintenance.get

Описание

целое число/массив maintenance.get(объект параметры)

Этот метод позволяет получать обслуживания в соответствии с заданными параметрами.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр	Тип	Описание
groupids	строка/массив	Возврат только тех обслуживаний, которые назначены на заданные группы узлов сети.
hostids	строка/массив	Возврат только тех обслуживаний, которые назначены на заданные узлы сети.
maintenanceids	строка/массив	Возврат обслуживаний только с заданными ID.
selectGroups	запрос	Возврат групп узлов сети, которые назначены на обслуживание, в свойстве `groups`.
selectHosts	запрос	Возврат узлов сети, которые назначены на обслуживание, в свойстве `hosts`.
selectTimeperiods	запрос	Возврат периодов времени обслуживания в свойстве `timeperiods`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `maintenanceid`, `name` и `maintenance_type`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
nodeids	строка/массив
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

Возвращаемые значения

(целое число/массив) Возвращает либо:

массив объектов;
количество найденных объектов, если используется параметр countOutput.

Примеры

Получение обслуживаний

Получение всех имеющихся обслуживаний, а также данных о назначенных группах узлов сети, узлов сети и добавленных периодах времени.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "maintenance.get",
           "params": {
               "output": "extend",
               "selectGroups": "extend",
               "selectTimeperiods": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "maintenanceid": "3",
                   "name": "Sunday maintenance",
                   "maintenance_type": "0",
                   "description": "",
                   "active_since": "1358844540",
                   "active_till": "1390466940",
                   "groups": [
                       {
                           "groupid": "4",
                           "name": "Zabbix servers",
                           "internal": "0"
                       }
                   ],
                   "timeperiods": [
                       {
                           "timeperiodid": "4",
                           "timeperiod_type": "3",
                           "every": "1",
                           "month": "0",
                           "dayofweek": "1",
                           "day": "0",
                           "start_time": "64800",
                           "period": "3600",
                           "start_date": "2147483647"
                       }
                   ]
               }
           ],
           "id": 1
       }

Смотрите также

Исходный код

CMaintenance::get() в frontends/php/api/classes/CMaintenance.php.

Documentation