action.get

Beschrijving

integer/array action.get(object parameters)

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

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kunnen 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
actionids	string/array	Alleen acties retourneren met de opgegeven ID's.
groupids	string/array	Alleen acties retourneren die de opgegeven hostgroepen gebruiken in actievoorwaarden.
hostids	string/array	Alleen acties retourneren die de opgegeven hosts gebruiken in actievoorwaarden.
triggerids	string/array	Alleen acties retourneren die de opgegeven triggers gebruiken in actievoorwaarden.
mediatypeids	string/array	Alleen acties retourneren die de opgegeven mediatypen gebruiken om berichten te verzenden.
usrgrpids	string/array	Alleen acties retourneren die zijn geconfigureerd om berichten naar de opgegeven gebruikersgroepen te sturen.
userids	string/array	Alleen acties retourneren die zijn geconfigureerd om berichten naar de opgegeven gebruikers te sturen.
scriptids	string/array	Alleen acties retourneren die zijn geconfigureerd om de opgegeven scripts uit te voeren.
selectFilter	query	Een filter eigenschap retourneren met de actievoorwaardenfilter.
selectOperations	query	Een operations eigenschap retourneren met actiebewerkingen.
selectRecoveryOperations	query	Een recovery_operations eigenschap retourneren met herstelbewerkingen voor acties.
selectUpdateOperations	query	Een update_operations eigenschap retourneren met bijgewerkte bewerkingen voor acties.
sortfield	string/array	De resultaten sorteren op de opgegeven eigenschappen. Mogelijke waarden: `actionid`, `name`, `status`.
countOutput	boolean	Deze parameters zijn gemeenschappelijk voor alle `get` methoden en worden beschreven in de referentietoelichting.
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

Triggertaken ophalen

Haal alle geconfigureerde triggertaken op, samen met actievoorwaarden en bewerkingen.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "action.get",
           "params": {
               "output": "extend",
               "selectOperations": "extend",
               "selectRecoveryOperations": "extend",
               "selectUpdateOperations": "extend",
               "selectFilter": "extend",
               "filter": {
                   "eventsource": 0
               }
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "actionid": "3",
                   "name": "Meld problemen aan Zabbix-beheerders",
                   "eventsource": "0",
                   "status": "1",
                   "esc_period": "1h",
                   "pause_suppressed": "1",
                   "filter": {
                       "evaltype": "0",
                       "formula": "",
                       "conditions": [],
                       "eval_formula": ""
                   },
                   "operations": [
                       {
                           "operationid": "3",
                           "actionid": "3",
                           "operationtype": "0",
                           "esc_period": "0",
                           "esc_step_from": "1",
                           "esc_step_to": "1",
                           "evaltype": "0",
                           "opconditions": [],
                           "opmessage": [
                               {
                                   "default_msg": "1",
                                   "subject": "",
                                   "message": "",
                                   "mediatypeid": "0"
                               }
                           ],
                           "opmessage_grp": [
                               {
                                   "usrgrpid": "7"
                               }
                           ]
                       }
                   ],
                   "recovery_operations": [
                       {
                           "operationid": "7",
                           "actionid": "3",
                           "operationtype": "11",
                           "evaltype": "0",
                           "opconditions": [],
                           "opmessage": {
                               "default_msg": "0",
                               "subject": "{TRIGGER.STATUS}: {TRIGGER.NAME}",
                               "message": "Trigger: {TRIGGER.NAME}\r\nTrigger status: {TRIGGER.STATUS}\r\nTrigger severity: {TRIGGER.SEVERITY}\r\nTrigger URL: {TRIGGER.URL}\r\n\r\nItem values:\r\n\r\n1. {ITEM.NAME1} ({HOST.NAME1}:{ITEM.KEY1}): {ITEM.VALUE1}\r\n2. {ITEM.NAME2} ({HOST.NAME2}:{ITEM.KEY2}): {ITEM.VALUE2}\r\n3. {ITEM.NAME3} ({HOST.NAME3}:{ITEM.KEY3}): {ITEM.VALUE3}\r\n\r\nOriginal event ID: {EVENT.ID}",
                               "mediatypeid": "0"
                           }
                       }
                   ],
                   "update_operations": [
                       {
                           "operationid": "31",
                           "operationtype": "12",
                           "evaltype": "0",
                           "opmessage": {
                               "default_msg": "1",
                               "subject": "",
                               "message": "",
                               "mediatypeid": "0"
                           }
                       },
                       {
                           "operationid": "32",
                           "operationtype": "0",
                           "evaltype": "0",
                           "opmessage": {
                               "default_msg": "0",
                               "subject": "Bijgewerkt: {TRIGGER.NAME}",
                               "message": "{USER.FULLNAME} heeft het probleem bijgewerkt op {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} met de volgende boodschap:\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nHuidige probleemstatus is {EVENT.STATUS}",
                               "mediatypeid": "1"
                           },
                           "opmessage_grp": [
                               {
                                   "usrgrpid": "7"
                               }
                           ],
                           "opmessage_usr": []
                       },
                       {
                           "operationid": "33",
                           "operationtype": "1",
                           "evaltype": "0",
                           "opcommand": {
                               "scriptid": "3"
                           },
                           "opcommand_hst": [
                               {
                                   "hostid": "10084"
                               }
                           ],
                           "opcommand_grp": []
                       }
                   ]
               }
           ],
           "id": 1
       }

Ontdekkingstaken ophalen

Haal alle geconfigureerde ontdekkingstaken op, samen met actievoorwaarden en bewerkingen. De filter gebruikt de evaluatiemethode "and", dus de eigenschap formula is leeg en eval_formula wordt automatisch gegenereerd.