problem.get

Beschrijving

integer/array problem.get(object parameters)

De methode maakt het mogelijk om problemen op te halen volgens de gegeven parameters.

Deze methode is voor het ophalen van onopgeloste problemen. Het is ook mogelijk, indien opgegeven, om bovendien recent opgeloste problemen op te halen. De periode die bepaalt hoe oud "recent" is, wordt gedefinieerd in AdministratieAlgemeen. Problemen die voor die periode zijn opgelost, worden niet bewaard in de probleem tafel. Om problemen op te halen die verderop in zijn opgelost het verleden, gebruik dan de event.get methode.

Deze methode kan problemen van een verwijderde teruggeven entiteit als deze problemen niet door de huishoudster zijn verholpen nog.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
eventids string/array Retourneer alleen problemen met de opgegeven ID's.
groupids string/array Retourneer alleen problemen die zijn gemaakt door objecten die tot de opgegeven hostgroepen behoren.
hostids string/array Retourneer alleen problemen die zijn gemaakt door objecten die bij de opgegeven hosts horen.
objectids string/array Retourneer alleen problemen die door de opgegeven objecten zijn gemaakt.
source integer Retourneer alleen problemen met het opgegeven type.

Raadpleeg de pagina met probleemgebeurtenisobjecten voor een lijst met ondersteunde gebeurtenistypen.

Standaard: 0 - probleem gecreëerd door een trigger.
object geheel getal Retourneer alleen problemen die zijn gemaakt door objecten van het opgegeven type.

Raadpleeg de pagina met probleemgebeurtenisobjecten voor een lijst met ondersteunde objecttypen.

Standaard: 0 - trigger.
acknowledged boolean true - retourneer alleen erkende problemen;
false - alleen niet-acknowledged.
suppressed boolean true - retourneert alleen onderdrukte problemen;
false - retourneert problemen in de normale staat.
severities integer/array Retourneer alleen problemen met de opgegeven gebeurtenisernst. Is alleen van toepassing als object trigger is.
evaltype integer Regels voor het zoeken naar tags.

Mogelijke waarden:
0 - (standaard) And/Or;
2 - Or.
tags array van objecten Retourneer alleen problemen met opgegeven tags. Exacte overeenkomst op tag en hoofdletterongevoelig zoeken op waarde en operator.
Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator> "}, ...].
Een lege array retourneert alle problemen.

Mogelijke typen operatoren:
0 - (standaard) Like;
1 - Equal;
2 - Niet leuk;
3 - Niet gelijk
4 - Bestaat;
5 - Bestaat niet.
recent boolean true - retourneer PROBLEEM en recent OPGELOST problemen (afhankelijk van Display OK-triggers gedurende N seconden)
Standaard: false - alleen ONOPGELOST problemen
eventid_from string Retourneer alleen problemen met ID's groter of gelijk aan de opgegeven ID.
eventid_till string Retourneer alleen problemen met ID's die kleiner of gelijk zijn aan de opgegeven ID.
time_from timestamp Retourneer alleen problemen die zijn gemaakt na of op het opgegeven tijdstip.
time_till timestamp Retourneer alleen problemen die eerder of op het opgegeven tijdstip zijn gemaakt.
selectAcknowledges query Retourneer een acknowledges eigenschap met de probleemupdates. Probleemupdates worden in omgekeerde chronologische volgorde gesorteerd.

Het probleemupdate-object heeft de volgende eigenschappen:
acknowledgeid - (string) update-ID;
userid - (string) ID van de gebruiker die de gebeurtenis heeft bijgewerkt;
eventid - (string) ID van de bijgewerkte gebeurtenis;
clock - (timestamp) tijd waarop de gebeurtenis is bijgewerkt;
message - (string) tekst van het bericht;
action - (integer)type update-actie (zie event.acknowledge) ;
old_severity - (integer) ernst van de gebeurtenis vóór deze update-actie;
new_severity - (integer) ernst van de gebeurtenis na deze update-actie;

Ondersteunt count.
selectTags query Retourneer een eigenschap tags met de probleemtags. Uitvoerformaat: [{"tag": "<tag>", "waarde": "<waarde>"}, ...].
selectSuppressionData query Retourneer een eigenschap suppression_data met de lijst met onderhoud:
maintenanceid - (string) ID van het onderhoud;
suppress_until - (integer) tijd tot het probleem wordt onderdrukt.
sortfield string/array Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn: eventid.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven op de pagina referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoek object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Ophalen van trigger probleem gebeurtenissen

Haal recente gebeurtenissen op uit trigger '15112'.

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "problem.get",
           "params": {
               "output": "extend",
               "selectAcknowledges": "extend",
               "selectTags": "extend",
               "selectSuppressionData": "extend",
               "objectids": "15112",
               "recent": "true",
               "sortfield": ["eventid"],
               "sortorder": "DESC"
           },
           "auth": "67f45d3eb1173338e1b1647c4bdc1916",
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "1245463",
                   "source": "0",
                   "object": "0",
                   "objectid": "15112",
                   "clock": "1472457242",
                   "ns": "209442442",
                   "r_eventid": "1245468",
                   "r_clock": "1472457285",
                   "r_ns": "125644870",
                   "correlationid": "0",
                   "userid": "1",
                   "name": "Zabbix agent on localhost is unreachable for 5 minutes",
                   "acknowledged": "1",
                   "severity": "3",
                   "opdata": "",
                   "acknowledges": [
                       {
                           "acknowledgeid": "14443",
                           "userid": "1",
                           "eventid": "1245463",
                           "clock": "1472457281",
                           "message": "problem solved",
                           "action": "6",
                           "old_severity": "0",
                           "new_severity": "0"
                       }
                   ],
                   "suppression_data": [
                       {
                           "maintenanceid": "15",
                           "suppress_until": "1472511600"
                       }
                   ],
                   "suppressed": "1",
                   "tags": [
                       {
                           "tag": "test tag",
                           "value": "test value"
                       }
                   ]
               }
           ],
           "id": 1
       }

Zie ook

Bron

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