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 Tipo Descrizione
groupids ID/array Restituisce solo le manutenzioni assegnate ai gruppi di host specificati.
hostids ID/array Restituisce solo le manutenzioni assegnate agli host specificati.
triggerids ID/array Restituisce solo le manutenzioni assegnate ai trigger specificati.
maintenanceids ID/array Restituisce solo le manutenzioni con gli ID specificati.
selectHostGroups query Restituisce una proprietà hostgroups con i gruppi di host assegnati alla manutenzione.
selectHosts query Restituisce una proprietà hosts con gli host assegnati alla manutenzione.
selectTriggers query Restituisce una proprietà triggers con i trigger assegnati alla manutenzione.
selectEventNames query Restituisce una proprietà event_names con i nomi degli eventi assegnati alla manutenzione.
selectTags query Restituisce una proprietà tags con i tag dei problemi della manutenzione.
selectTimeperiods query Restituisce una proprietà timeperiods con i periodi di tempo della manutenzione.
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, i dati relativi all'ambito di manutenzione assegnato (gruppo di host, host, trigger, nome dell'evento, tag) e i periodi di tempo definiti.

Richiesta:

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

Risposta:


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Manutenzione regolare del database",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Database",
          "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: Stampante: inchiostro ESAURITO",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Server Zabbix",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Stampante: inchiostro ESAURITO"
        }
      ],
      "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})
### Vedi anche

-   [Host](/manual/api/reference/host/object#host)
-   [Gruppo di host](/manual/api/reference/hostgroup/object#host-group)
-   [Trigger](/manual/api/reference/trigger/object#trigger)
-   [Nome dell'evento](object#event-name)
-   [Tag del problema](object#problem-tag)
-   [Periodo di tempo](object#time-period)

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

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

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

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