maintenance.get

Описание

integer/array maintenance.get(object parameters)

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

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

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
groupids ID/array Возвращать только обслуживания, назначенные указанным группам узлов сети.
hostids ID/array Возвращать только обслуживания, назначенные указанным узлам сети.
maintenanceids ID/array Возвращать только обслуживания с указанными ID.
selectHostGroups query Возвращать свойство hostgroups с группами узлов сети, назначенными обслуживанию.
selectHosts query Возвращать свойство hosts с узлами сети, назначенными обслуживанию.
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",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "Sunday maintenance",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "hostgroups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "flags": "0",
                    "uuid": "6f6799aa69e844b4b3918f779f2abf08"
                }
            ],
            "timeperiods": [
                {
                    "timeperiod_type": "3",
                    "every": "1",
                    "month": "0",
                    "dayofweek": "1",
                    "day": "0",
                    "start_time": "64800",
                    "period": "3600",
                    "start_date": "2147483647"
                }
            ],
            "tags": [
                {
                    "tag": "service",
                    "operator": "0",
                    "value": "mysqld",
                },
                {
                    "tag": "error",
                    "operator": "2",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

См. также

Исходный код

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