maintenance.get

Descrizione

integer/array maintenance.get(object parameters)

Il metodo consente di recuperare le manutenzioni in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per richiamare il metodo possono essere revocate nelle impostazioni dei ruoli utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Type Descrizione
groupids ID/array Restituisce solo le maintenance assegnate ai gruppi di host specificati.
hostids ID/array Restituisce solo le maintenance assegnate agli host specificati.
maintenanceids ID/array Restituisce solo le maintenance con gli ID specificati.
selectHostGroups query Restituisce una proprietà hostgroups con i gruppi di host assegnati alla maintenance.
selectHosts query Restituisce una proprietà hosts con gli host assegnati alla maintenance.
selectTags query Restituisce una proprietà tags con i tag problema della maintenance.
selectTimeperiods query Restituisce una proprietà timeperiods con i periodi di tempo della maintenance.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce uno dei seguenti:

  • un array di oggetti;
  • il numero di oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recupero delle manutenzioni

Recupera tutte le manutenzioni configurate e i dati relativi ai gruppi di host assegnati, ai periodi di tempo definiti e ai tag dei problemi.

Richiesta:

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

Risposta:

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

Vedi anche

Sorgente

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