This is a translation of the original English documentation page. Help us make it better.

problem.get

Beschrijving

integer/array problem.get(object parameters)

Deze methode maakt het mogelijk om problemen op te halen op basis van de opgegeven parameters.

Deze methode is bedoeld voor het ophalen van onopgeloste problemen. Het is ook mogelijk om, indien gespecificeerd, recent opgeloste problemen op te halen. De periode die bepaalt hoe oud "recent" is, wordt gedefinieerd in BeheerAlgemeen. Problemen die voorafgaand aan die periode zijn opgelost, worden niet in de probleemtabel bewaard. Om problemen op te halen die verder in het verleden zijn opgelost, gebruikt u de methode event.get.

Deze methode kan problemen van een verwijderde entiteit retourneren als deze problemen nog niet zijn verwijderd door de opruimfunctie.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemmingen om de methode te gebruiken, kunnen 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
eventids string/array Geeft alleen problemen terug met de opgegeven ID's.
groupids string/array Geeft alleen problemen terug die zijn gemaakt door objecten die tot de opgegeven hostgroepen behoren.
hostids string/array Geeft alleen problemen terug die zijn gemaakt door objecten die tot de opgegeven hosts behoren.
objectids string/array Geeft alleen problemen terug die zijn gemaakt door de opgegeven objecten.
source integer Geeft alleen problemen terug van het opgegeven type.

Zie de probleemgebeurtenis objectpagina voor een lijst met ondersteunde gebeurtenistypen.

Standaard: 0 - probleem gemaakt door een trigger.
object integer Geeft alleen problemen terug die zijn gemaakt door objecten van het opgegeven type.

Zie de probleemgebeurtenis objectpagina voor een lijst met ondersteunde objecttypen.

Standaard: 0 - trigger.
acknowledged boolean true - geeft alleen erkende problemen terug;
false - geeft alleen niet-erkende problemen terug.
suppressed boolean true - geeft alleen onderdrukte problemen terug;
false - geeft problemen terug in de normale status.
symptom boolean true - geeft alleen problemen terug van het symptoomgebeurtenistype;
false - geeft alleen problemen terug van het oorzaakgebeurtenistype.
severities integer/array Geeft alleen problemen terug met de opgegeven gebeurtenisernst. Alleen van toepassing als het object een trigger is.
evaltype integer Regels voor tag-zoeken.

Mogelijke waarden:
0 - (standaard) En/Of;
2 - Of.
tags array van objecten Geeft alleen problemen terug met de opgegeven tags. Exacte overeenkomst op tag en niet-hoofdlettergevoelige zoekopdracht op waarde en operator.
Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Een lege array geeft alle problemen terug.

Mogelijke operatortypes:
0 - (standaard) Like;
1 - Gelijk;
2 - Not like;
3 - Niet gelijk aan
4 - Bestaat;
5 - Bestaat niet.
recent boolean true - geeft PROBLEEM en recent OPGELOSTE problemen terug (afhankelijk van Display OK triggers for N seconds)
Standaard: false - ALLEEN ONGELOSTE problemen
eventid_from string Geeft alleen problemen terug met ID's groter dan of gelijk aan het opgegeven ID.
eventid_till string Geeft alleen problemen terug met ID's kleiner dan of gelijk aan het opgegeven ID.
time_from timestamp Geeft alleen problemen terug die zijn gemaakt na of op het opgegeven tijdstip.
time_till timestamp Geeft alleen problemen terug die zijn gemaakt voor of op het opgegeven tijdstip.
selectAcknowledges query Geeft een acknowledges eigenschap terug met de problem-updates. Probleemupdates zijn gesorteerd in omgekeerde chronologische volgorde.

Het probleem-update object heeft de volgende eigenschappen:
acknowledgeid - (string) ID van de update;
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) gebeurtenisernst vóór deze update-actie;
new_severity - (integer) gebeurtenisernst na deze update-actie;
suppress_until - (timestamp) tijd tot de gebeurtenis wordt onderdrukt;
taskid - (string) ID van de taak als de huidige gebeurtenis een rangwijziging ondergaat;

Ondersteunt count.
selectTags query Geeft een tags eigenschap terug met de probleemtags. Uitvoerformaat: [{"tag": "<tag>", "value": "<value>"}, ...].
selectSuppressionData query Geeft een suppression_data eigenschap terug met de lijst van actieve onderhoudsperioden en handmatige onderdrukkingen:
maintenanceid - (string) ID van het onderhoud;
userid - (string) ID van de gebruiker die het probleem heeft onderdrukt;
suppress_until - (integer) tijd tot het probleem wordt onderdrukt.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: eventid.
countOutput boolean Deze parameters, die gemeenschappelijk zijn voor alle get methoden, worden in detail beschreven in de referentie toelichting pagina.
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

Ophalen van probleemgebeurtenissen van triggers

Haal recente gebeurtenissen op van trigger "15112".

Aanvraag:

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

Reactie:

{
           "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",
                   "cause_eventid": "0",
                   "opdata": "",
                   "acknowledges": [
                       {
                           "acknowledgeid": "14443",
                           "userid": "1",
                           "eventid": "1245463",
                           "clock": "1472457281",
                           "message": "probleem opgelost",
                           "action": "6",
                           "old_severity": "0",
                           "new_severity": "0",
                           "suppress_until": "1472511600",
                           "taskid": "0"
                       }
                   ],
                   "suppression_data": [
                       {
                           "maintenanceid": "15",
                           "suppress_until": "1472511600",
                           "userid": "0"
                       }
                   ],
                   "suppressed": "1",
                   "tags": [
                       {
                           "tag": "test tag",
                           "value": "testwaarde"
                       }
                   ]
               }
           ],
           "id": 1
       }

Retrieving problems acknowledged by specified user

Retrieving problems acknowledged by user with ID=10

Request:

{
           "jsonrpc": "2.0",
           "method": "problem.get",
           "params": {
               "output": "extend",
               "action": 2,
               "action_userids": [10],
               "selectAcknowledges": ["userid", "action"],
               "sortfield": ["eventid"],
               "sortorder": "DESC"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "1248566",
                   "source": "0",
                   "object": "0",
                   "objectid": "15142",
                   "clock": "1472457242",
                   "ns": "209442442",
                   "r_eventid": "1245468",
                   "r_clock": "1472457285",
                   "r_ns": "125644870",
                   "correlationid": "0",
                   "userid": "10",
                   "name": "Zabbix agent on localhost is unreachable for 5 minutes",
                   "acknowledged": "1",
                   "severity": "3",
                   "cause_eventid": "0",
                   "opdata": "",
                   "acknowledges": [
                       {
                           "userid": "10",
                           "action": "2"
                       }
                   ],
                   "suppressed": "0"
               }
           ],
           "id": 1
       }

Zie ook

Bron

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