action.get

COMENTARIO https://git.zabbix.com/projects/WEB/repos/documentation/browse/en/manual/api/reference/action/get.md?at=refs%2Fheads%2Frelease%2F6.0 CONTEXTO manual/api/reference/action/get.md RECURSO Documentación 6.0•manual/api/reference/action/get.xliff

Descripción

integer/array action.get(object parameters)

El método permite recuperar las acciones de acuerdo a los parámetros aportados.

Este método está disponible para los usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en las opciones de rol de usuario. Ver Roles de usuario para más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
actionids	string/array	Devuelve solo las acciones con los IDs indicados.
groupids	string/array	Devuelve solo las acciones que incluyen en sus condiciones de acción los grupos de equipos indicados.
hostids	string/array	Devuelve solo las acciones que incluyen en sus condiciones de acción los equipos indicados.
triggerids	string/array	Devuelve solo las acciones que incluyen en sus condiciones de acción los iniciadores indicados.
mediatypeids	string/array	Devuelve solo las acciones que usan los tipos de medios indicados para enviar mensajes.
usrgrpids	string/array	Devuelve solo las acciones configuradas para enviar mensajes a los grupos de usuario indicados.
userids	string/array	Devuelve solo las acciones configuradas para enviar mensajes a los usuarios indicados.
scriptids	string/array	Devuelve solo las acciones configuradas para ejecutar los scripts indicados.
selectFilter	query	Devuelve una propiedad de filtro con el filtro de condición de acción.
selectOperations	query	Devuelve una propiedad de operations con operaciones de acción.
selectRecoveryOperations	query	Devuelve una propiedad de recovery_operations con operaciones de recuperación.
selectUpdateOperations	query	Devuelve una propiedad de update_operations con operaciones de actualización.
sortfield	string/array	Ordena los resultados por las propiedades indicadas. Los posibles valores son: `actionid`, `name` y `status`.
countOutput	boolean	Estos parámetros son comunes para todos los métodos `get` descritos en el comentario de referencia.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores devueltos

(interger/array) devuelve cualquiera:

un arreglo de objetos;
el contador de los objetos devueltos, si el parámetro countOutput ha sido utilizado.

Ejemplos

Retrieve trigger actions

Retrieve all configured trigger actions together with action conditions and operations.

Request:

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

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "actionid": "3",
                   "name": "Report problems to Zabbix administrators",
                   "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": "Updated: {TRIGGER.NAME}",
                               "message": "{USER.FULLNAME} updated problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} with the following message:\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nCurrent problem status 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
       }

Retrieve discovery actions

Retrieve all configured discovery actions together with action conditions and operations. The filter uses the "and" evaluation type, so the formula property is empty and eval_formula is generated automatically.