alert.get

Descrizione

integer/array alert.get(object parameters)

Il metodo permette di recuperare gli alert in base ai parametri forniti.

Questo metodo è disponibile a qualunque tipo di utente. I permessi per la chiamate del metodo possono essere revocati nei settaggi del ruolo utene. Vedi User roles per maggiori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parameter Type Description
alertids ID/array Restituisce solo gli alert con gli ID specificati.
actionids ID/array Restituisce solo gli alert generati dalle azioni specificate.
eventids ID/array Restituisce solo gli alert generati dagli eventi specificati.
groupids ID/array Restituisce solo gli alert generati da oggetti appartenenti ai gruppi di host specificati.
hostids ID/array Restituisce solo gli alert generati da oggetti appartenenti agli host specificati.
mediatypeids ID/array Restituisce solo gli alert di messaggio che hanno utilizzato i tipi di media specificati.
objectids ID/array Restituisce solo gli alert generati dagli oggetti specificati
userids ID/array Restituisce solo gli alert di messaggio inviati agli utenti specificati.
eventobject integer Restituisce solo gli alert generati da eventi relativi a oggetti del tipo specificato.

Vedere event object per un elenco dei tipi di oggetto supportati.

Predefinito: 0 - trigger.
eventsource integer Restituisce solo gli alert generati da eventi del tipo specificato.

Vedere event source per un elenco dei tipi di evento supportati.

Predefinito: 0 - eventi trigger.
time_from timestamp Restituisce solo gli alert generati dopo l'ora specificata.
time_till timestamp Restituisce solo gli alert generati prima dell'ora specificata.
selectHosts query Restituisce una proprietà hosts con i dati degli host che hanno attivato l'operazione dell'azione.
selectMediatypes query Restituisce una proprietà mediatypes con un array dei tipi di media utilizzati per l'alert di messaggio.

Vedere mediatype.get per le restrizioni basate sul tipo di utente.
selectUsers query Restituisce una proprietà users con un array degli utenti a cui era indirizzato il messaggio.

Vedere user.get per le restrizioni basate sul tipo di utente.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: alertid, clock, eventid, mediatypeid, sendto, status.
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

In Zabbix 7.0.9, gli utenti di tipo Admin e User possono recuperare i dati degli alert di tipo "message" (0) solo relativi al proprio utente.

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput ha stato usato.

Esempi

Recuperare gli alert per ID azione

Recupera tutti gli alert generati dall'azione "3".

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "[email protected]",
            "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
            "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}

Vedi anche

Sorgente

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