maintenance.get

Beschreibung

integer/array maintenance.get(object parameters)

Die Methode ermöglicht es Ihnen, Wartungen anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter zur Definition der gewünschten Ausgabe.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
groupids ID/array Gibt nur Wartungen zurück, die den angegebenen Hostgruppen zugewiesen sind.
hostids ID/array Gibt nur Wartungen zurück, die den angegebenen Hosts zugewiesen sind.
triggerids ID/array Gibt nur Wartungen zurück, die den angegebenen Auslösern zugewiesen sind.
maintenanceids ID/array Gibt nur Wartungen mit den angegebenen IDs zurück.
selectHostGroups query Gibt eine Eigenschaft hostgroups mit den der Wartung zugewiesenen Hostgruppen zurück.
selectHosts query Gibt eine Eigenschaft hosts mit den der Wartung zugewiesenen Hosts zurück.
selectTriggers query Gibt eine Eigenschaft triggers mit den der Wartung zugewiesenen Auslösern zurück.
selectEventNames query Gibt eine Eigenschaft event_names mit den der Wartung zugewiesenen Ereignisnamen zurück.
selectTags query Gibt eine Eigenschaft tags mit den Problem-Tags der Wartung zurück.
selectTimeperiods query Gibt eine Eigenschaft timeperiods mit den Zeiträumen der Wartung zurück.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Wartungen abrufen

Rufen Sie alle konfigurierten Wartungen, die Daten zum zugewiesenen Wartungsumfang (Hostgruppe, Host, Auslöser, Ereignisname, Tags) sowie die definierten Zeiträume ab.

Anfrage:

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

Antwort:


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Regelmäßige DB-Wartung",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Datenbanken",
          "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: Drucker: Tinte LEER",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Zabbix-Server",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Drucker: Tinte LEER"
        }
      ],
      "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})
### Siehe auch

-   [Host](/manual/api/reference/host/object#host)
-   [Host-Gruppe](/manual/api/reference/hostgroup/object#host-group)
-   [Auslöser](/manual/api/reference/trigger/object#trigger)
-   [Ereignisname](object#event-name)
-   [Problem-Tag](object#problem-tag)
-   [Zeitraum](object#time-period)

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

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

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

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