maintenance.create

Описание

object maintenance.create(объект/массив maintenances)

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

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

Параметры

(object/array) Создаваемые обслуживания.

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

Parameter Type Description
groups object/array Группы узлов сети, которые будут переведены на обслуживание.

Группы узлов сети должны иметь определенным только свойство groupid.

Поведение параметра:
- required если hosts не задан
hosts object/array Узлы сети, которые будут переведены на обслуживание.

У узлов сети должно быть определенным только свойство hostid.

Поведение параметра:
- required если groups не задан
timeperiods object/array Периоды времени обслуживания.

Поведение параметра:
- required
tags object/array Теги проблем.

Определяют, какие проблемы должны быть подавлены.
Если теги не заданы, будут подавлены все активные проблемы узлов сети в обслуживании.

Поведение параметра:
- supported если maintenance_type объекта Maintenance object установлен в "with data collection"
groupids
(deprecated)		 array Этот параметр устарел, вместо него используйте groups.
Идентификаторы групп узлов сети, которые будут переведены на обслуживание.
hostids
(deprecated)		 array Этот параметр устарел, вместо него используйте hosts.
Идентификаторы узлов сети, которые будут переведены на обслуживание.

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

(объект) Возвращает объект, который содержит ID созданных обслуживаний, указанных в свойстве maintenanceids. Порядок возвращаемых ID совпадает с порядком переданных обслуживаний.

Примеры

Создание обслуживания

Создайте обслуживание со сбором данных для группы узлов сети с ID "2" и с тегами проблем service:mysqld и error. Оно должно быть активно с 17.03.2026 по 17.03.2027, вступать в силу каждое воскресенье в 18:00 и длиться один час.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "maintenance.create",
    "params": {
        "name": "Sunday maintenance",
        "active_since": 1773720240,
        "active_till": 1805256240,
        "tags_evaltype": 0,
        "groups": [
            {"groupid": "2"}
        ],
        "timeperiods": [
            {
                "period": 3600,
                "timeperiod_type": 3,
                "start_time": 64800,
                "every": 1,
                "dayofweek": 64
            }
        ],
        "tags": [
            {
                "tag": "service",
                "operator": "0",
                "value": "mysqld"
            },
            {
                "tag": "error",
                "operator": "2",
                "value": ""
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "maintenanceids": [
            "3"
        ]
    },
    "id": 1
}

См. также

Источник

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