maintenance.get

Beschreibung

integer/array maintenance.get(object parameters)

Mit dieser Methode können Wartungen entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
groupids ID/array Nur Wartungen zurückgeben, die den angegebenen Host-Gruppen zugeordnet sind.
hostids ID/array Nur Wartungen zurückgeben, die den angegebenen Hosts zugeordnet sind.
maintenanceids ID/array Nur Wartungen mit den angegebenen IDs zurückgeben.
selectHostGroups query Eine Eigenschaft hostgroups mit den der Wartung zugeordneten Host-Gruppen zurückgeben.
selectHosts query Eine Eigenschaft hosts mit den der Wartung zugeordneten Hosts zurückgeben.
selectTags query Eine Eigenschaft tags mit den Problem-Tags der Wartung zurückgeben.
selectTimeperiods query Eine Eigenschaft timeperiods mit den Zeiträumen der Wartung zurückgeben.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen selectHostGroups.
Eine Eigenschaft groups mit den der Wartung zugeordneten Host-Gruppen zurückgeben.

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

Abrufen von Wartungen

Rufen Sie alle konfigurierten Wartungen sowie die Daten zu den zugewiesenen Host-Gruppen, definierten Zeiträumen und Problem-Tags ab.

Anfrage:

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

Antwort:

{
    "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
}

Siehe auch

Quelle

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