alert.get

Beschrijving

integer/array alert.get(object parameters)

Deze methode maakt het mogelijk om meldingen op te halen volgens de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. De toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Omschrijving
alertids	string/array	Geeft alleen meldingen terug met de opgegeven ID's.
actionids	string/array	Geeft alleen meldingen terug die zijn gegenereerd door de opgegeven acties.
eventids	string/array	Geeft alleen meldingen terug die zijn gegenereerd door de opgegeven gebeurtenissen.
groupids	string/array	Geeft alleen meldingen terug die zijn gegenereerd door objecten uit de opgegeven hostgroepen.
hostids	string/array	Geeft alleen meldingen terug die zijn gegenereerd door objecten uit de opgegeven hosts.
mediatypeids	string/array	Geeft alleen berichtmeldingen terug die de opgegeven mediatypen hebben gebruikt.
objectids	string/array	Geeft alleen meldingen terug die zijn gegenereerd door de opgegeven objecten
userids	string/array	Geeft alleen berichtmeldingen terug die naar de opgegeven gebruikers zijn gestuurd.
eventobject	integer	Geeft alleen meldingen terug die zijn gegenereerd door gebeurtenissen die verband houden met objecten van het opgegeven type. Zie gebeurtenisobject voor een lijst van ondersteunde objecttypen. Standaard: 0 - trigger.
eventsource	integer	Geeft alleen meldingen terug die zijn gegenereerd door gebeurtenissen van het opgegeven type. Zie gebeurtenisbron voor een lijst van ondersteunde gebeurtenistypen. Standaard: 0 - triggergebeurtenissen.
time_from	timestamp	Geeft alleen meldingen terug die zijn gegenereerd na het opgegeven tijdstip.
time_till	timestamp	Geeft alleen meldingen terug die zijn gegenereerd vóór het opgegeven tijdstip.
selectHosts	query	Geeft een hosts eigenschap terug met gegevens van hosts die de actiebewerking hebben getriggerd.
selectMediatypes	query	Geeft een mediatypes eigenschap terug met een array van de mediatypen die zijn gebruikt voor de berichtmelding.
selectUsers	query	Geeft een users eigenschap terug met een array van de gebruikers waarnaar het bericht is gericht.
sortfield	string/array	Sorteer het resultaat op basis van de opgegeven eigenschappen. Mogelijke waarden: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto`, `status`.
countOutput	boolean	Deze parameters, die veel voorkomen bij alle `get`-methoden, worden beschreven in het referentiecommentaar.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Meldingen ophalen op basis van actie-ID

Haal alle meldingen op die zijn gegenereerd door actie "3".

Aanvraag:

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

Reactie:

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

Zie ook

Bron

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

Documentation