action.get
Beschreibung
integer/array action.get(object parameters)
Die Methode ermöglicht das Abrufen von Aktionen basierend auf den angegebenen Parametern.
Diese Methode ist für Benutzer aller Art verfügbar. Berechtigungen zum Aufrufen der Methode können in den Benutzerrolleneinstellungen widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.
Parameter
(object) Parameter, die die gewünschte Ausgabe definieren.
Die Methode unterstützt die folgenden Parameter.
| Parameter | Type | Beschreibung |
|---|---|---|
| actionids | ID/array | Gibt nur Aktionen mit den angegebenen IDs zurück. |
| groupids | ID/array | Gibt nur Aktionen zurück, die die angegebenen Host-Gruppen in Aktionsbedingungen verwenden. |
| hostids | ID/array | Gibt nur Aktionen zurück, die die angegebenen Hosts in Aktionsbedingungen verwenden. |
| triggerids | ID/array | Gibt nur Aktionen zurück, die die angegebenen Auslöser in Aktionsbedingungen verwenden. |
| mediatypeids | ID/array | Gibt nur Aktionen zurück, die die angegebenen Medientypen zum Senden von Nachrichten verwenden. |
| usrgrpids | ID/array | Gibt nur Aktionen zurück, die so konfiguriert sind, dass Nachrichten an die angegebenen Benutzergruppen gesendet werden. |
| userids | ID/array | Gibt nur Aktionen zurück, die so konfiguriert sind, dass Nachrichten an die angegebenen Benutzer gesendet werden. |
| scriptids | ID/array | Gibt nur Aktionen zurück, die so konfiguriert sind, dass die angegebenen Skripte ausgeführt werden. |
| selectFilter | query | Gibt eine Eigenschaft filter mit dem Filter für Aktionsbedingungen zurück. |
| selectOperations | query | Gibt eine Eigenschaft operations mit Aktionsoperationen zurück. |
| selectRecoveryOperations | query | Gibt eine Eigenschaft recovery_operations mit Wiederherstellungsoperationen der Aktion zurück. |
| selectUpdateOperations | query | Gibt eine Eigenschaft update_operations mit Aktualisierungsoperationen der Aktion zurück. |
| sortfield | string/array | Sortiert das Ergebnis nach den angegebenen Eigenschaften. Mögliche Werte: actionid, name, status. |
| countOutput | boolean | Diese Parameter werden im Referenzkommentar beschrieben. |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Rückgabewerte
(integer/array) Kann die folgenden Dinge zurück geben:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter
countOutputverwendet wurde.
Beispiele
Auslöser-Aktionen abrufen
Rufen Sie alle konfigurierten Auslöser-Aktionen zusammen mit Aktionsbedingungen und Operationen ab.
{
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectRecoveryOperations": "extend",
"selectUpdateOperations": "extend",
"selectFilter": "extend",
"filter": {
"eventsource": 0
}
},
"id": 1
}
Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"actionid": "3",
"name": "Probleme an Zabbix-Administratoren melden",
"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": "Auslöser: {TRIGGER.NAME}\r\nAuslöserstatus: {TRIGGER.STATUS}\r\nAuslöserschweregrad: {TRIGGER.SEVERITY}\r\nAuslöser-URL: {TRIGGER.URL}\r\n\r\nDatenpunktwerte:\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\nUrsprüngliche Ereignis-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": "Aktualisiert: {TRIGGER.NAME}",
"message": "{USER.FULLNAME} hat das Problem am {EVENT.UPDATE.DATE} um {EVENT.UPDATE.TIME} mit der folgenden Nachricht aktualisiert:\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nDer aktuelle Problemstatus ist {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
}
Discovery-Aktionen abrufen
Rufen Sie alle konfigurierten Discovery-Aktionen zusammen mit Aktionsbedingungen und Operationen ab. Der Filter verwendet den Auswertungstyp „and“, daher ist die Eigenschaft formula leer und eval_formula wird automatisch generiert.
{
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectFilter": "extend",
"filter": {
"eventsource": 1
}
},
"id": 1
}
Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"actionid": "2",
"name": "Auto discovery. Linux servers.",
"eventsource": "1",
"status": "1",
"esc_period": "0s",
"pause_suppressed": "1",
"filter": {
"evaltype": "0",
"formula": "",
"conditions": [
{
"conditiontype": "10",
"operator": "0",
"value": "0",
"value2": "",
"formulaid": "B"
},
{
"conditiontype": "8",
"operator": "0",
"value": "9",
"value2": "",
"formulaid": "C"
},
{
"conditiontype": "12",
"operator": "2",
"value": "Linux",
"value2": "",
"formulaid": "A"
}
],
"eval_formula": "A and B and C"
},
"operations": [
{
"operationid": "1",
"actionid": "2",
"operationtype": "6",
"esc_period": "0s",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opconditions": [],
"optemplate": [
{
"templateid": "10001"
}
]
},
{
"operationid": "2",
"actionid": "2",
"operationtype": "4",
"esc_period": "0s",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opconditions": [],
"opgroup": [
{
"groupid": "2"
}
]
}
]
}
],
"id": 1
}
Siehe auch
Quelle
CAction::get() in ui/include/classes/api/services/CAction.php.