maintenance.get

Описание

integer/array maintenance.get(object parameters)

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках роли пользователя. Дополнительную информацию см. в разделе User roles.

Параметры

(object) Параметры, определяющие требуемый результат.

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

Параметр Тип Описание
groupids ID/array Возвращать только периоды обслуживания, назначенные указанным группам узлов сети.
hostids ID/array Возвращать только периоды обслуживания, назначенные указанным узлам сети.
triggerids ID/array Возвращать только периоды обслуживания, назначенные указанным триггерам.
maintenanceids ID/array Возвращать только периоды обслуживания с указанными идентификаторами.
selectHostGroups query Возвращать свойство hostgroups с группами узлов сети, назначенными периоду обслуживания.
selectHosts query Возвращать свойство hosts с узлами сети, назначенными периоду обслуживания.
selectTriggers query Возвращать свойство triggers с триггерами, назначенными периоду обслуживания.
selectEventNames query Возвращать свойство event_names с именами событий, назначенными периоду обслуживания.
selectTags query Возвращать свойство tags с тегами проблем периода обслуживания.
selectTimeperiods query Возвращать свойство timeperiods с временными периодами обслуживания.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

(integer/array) Возвращает либо:

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

Примеры

Получение периодов обслуживания

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectHosts": "extend",
        "selectTriggers": "extend",
        "selectEventNames": "extend",
        "selectTags": "extend",
        "selectTimeperiods": "extend"
    },
    "id": 1
}

Ответ:


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Regular DB maintenance",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Databases",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "Ad-hoc: Printer: ink OUT",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Zabbix servers",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Printer: ink OUT"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}```

[comment]: # ({/ec7146e4-0b1cb387})

[comment]: # ({0c4dce96-dbcf678a})
### См. также

-   [Узел сети](/manual/api/reference/host/object#host)
-   [Группа узлов сети](/manual/api/reference/hostgroup/object#host-group)
-   [Триггер](/manual/api/reference/trigger/object#trigger)
-   [Имя события](object#event-name)
-   [Тег проблемы](object#problem-tag)
-   [Период времени](object#time-period)

[comment]: # ({/0c4dce96-dbcf678a})

[comment]: # ({f0ec3c40-50ed5be3})
### Источник

CMaintenance::get() в *ui/include/classes/api/services/CMaintenance.php*.

[comment]: # ({/f0ec3c40-50ed5be3})