alert.get

Descripció

integer/array alert.get(object parameters)

El mètode permet recuperar alertes segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

Aquest mètode suporta els paràmetres següents.

Paràmetre	Tipus	Descripció
alertids	ID/array	Retorna només alertes amb els IDs especificats.
actionids	ID/array	Retorna només alertes generades per les accions especificades.
eventids	ID/array	Retorna només alertes generades per els events especificats.
groupids	ID/array	Retorna només alertes generades per objectes dels grups d'equips especificats.
hostids	ID/array	Retorna només alertes generades per objectes dels equips especificats.
mediatypeids	ID/array	Retorna només missatges d'alertes que empren els tipus de mitjans especificats.
objectids	ID/array	Retorna només alertes generades per els objectes especificats.
userids	ID/array	Retorna només missatges d'alertes que es van enviar als usuaris especificats.
eventobject	integer	Retorna només alertes generades per events relacionats amb els objectes dels tipus especificats. Veieu l'event "object" for a list of supported object types. Per defecte: 0 - trigger.
eventsource	integer	Retorna només alertes generades per events del tipus especificat. Veieu l'esdeveniment "source" per obtindre una llista dels tipus d'events suportats. Per defecte: 0 - esdeveniments de triggers.
time_from	timestamp	Retorna només alertes generades per després de l'hora especificada.
time_till	timestamp	Retorna només alertes generades abans de l'hora especificada.
selectHosts	query	Retorna la propietat equips amb informació dels equips que han executat el trigger d'operació d'acció.
selectMediatypes	query	Retorna la propietat mediatypes amb una matriu dels tipus de mitjans que s'han emprat per al missatge d'alerta.
selectUsers	query	Retorna la propietat users amb una matriu dels usuaris als qui el missatge fou adreçat.
sortfield	string/array	Ordena el resultat per les propietats especificades. Possible values are: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto` i `status`.
countOutput	boolean	Aquesta paràmetres són els comuns per a tots els mètodes `get`, i són descrits al comentari de referència.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valors de retorn

(integer/array) Retorna:

una matriu d'objectes;
el recompte dels objectes recuperats, si s'ha emprat el paràmetre countOutput.

Exemples

Recuperar les alertes per l'ID d'acció

Recuperar totes les alertes generades per l'acció "3".

Petició:

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

Resposta:

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

Veieu també

Font

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

Documentation