alert.get

Descrizione

integer/array alert.get(object parameters)

Il metodo consente di recuperare gli alert in base ai parametri specificati.

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

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
alertids ID/array Restituisce solo gli avvisi con gli ID specificati.
actionids ID/array Restituisce solo gli avvisi generati dalle azioni specificate.
eventids ID/array Restituisce solo gli avvisi generati dagli eventi specificati.
groupids ID/array Restituisce solo gli avvisi generati da oggetti dei gruppi host specificati.
hostids ID/array Restituisce solo gli avvisi generati da oggetti degli host specificati.
mediatypeids ID/array Restituisce solo gli avvisi di messaggio che hanno utilizzato i tipi di supporto specificati.
objectids ID/array Restituisce solo gli avvisi generati dagli oggetti specificati
userids ID/array Restituisce solo gli avvisi di messaggio inviati agli utenti specificati.
eventobject integer Restituisce solo gli avvisi generati da eventi relativi a oggetti del tipo specificato.

Vedere object dell'evento per un elenco dei tipi di oggetto supportati.

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

Vedere source dell'evento per un elenco dei tipi di evento supportati.

Predefinito: 0 - eventi trigger.
time_from timestamp Restituisce solo gli avvisi generati dopo l'ora specificata.
time_till timestamp Restituisce solo gli avvisi 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 supporto utilizzati per l'avviso di messaggio.

Vedere mediatype.get per le limitazioni in base al 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 limitazioni in base al 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

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 avvisi per ID azione

Recupera tutti gli avvisi 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 sul server Linux non è raggiungibile da 5 minuti: ",
            "message": "Trigger: Zabbix agent sul server Linux non è raggiungibile da 5 minuti: \nStato del trigger: PROBLEM\nGravità del trigger: Non classificato",
            "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.