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

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

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
actionids	cadena/matriz	Devuelve sólo acciones con los ID proporcionados.
groupids	cadena/matriz	Devuelve solo acciones que utilizan los grupos de equipos dados en condiciones de acción.
hostids	cadena/matriz	Devuelve sólo acciones que utilizan los equipos dados en condiciones de acción.
triggerids	cadena/matriz	Devuelve sólo acciones que utilizan los iniciadores dados en las condiciones de acción.
mediatypeids	string/array	Devuelve solo acciones que utilizan los tipos de medios dados para enviar mensajes.
usrgrpids	string/array	Devuelve sólo acciones que están configuradas para enviar mensajes a los grupos de usuarios dados.
userids	cadena/matriz	Devuelve solo acciones que están configuradas para enviar mensajes a los usuarios dados.
scriptids	cadena/matriz	Devuelve sólo acciones que están configuradas para ejecutar los scripts dados.
selectFilter	query	Devuelve una propiedad filtro con el filtro de condición de acción.
selectOperations	query	Devuelve una propiedad operaciones con operaciones de acción.
selectRecoveryOperations	query	Devuelve una propiedad recovery_operatives con operaciones de recuperación de acciones.
selectUpdateOperations	query	Devuelve una propiedad update_operatives con operaciones de actualización de acciones.
sortfield	string/array	Ordena el resultado según las propiedades dadas. Los valores posibles son: `actionid`, `name` y `status`.
countOutput	boolean	Estos parámetros, que son comunes para todos los métodos `get`, se describen en el comentario de referencia.
excludeSearch	booleano
filter	objeto
limit	entero
output	consulta
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/matriz
startSearch	booleano

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

Recuperar acciones de iniciador

Recuperar todas las acciones de iniciador configuradas junto con las condiciones de acción y operaciones.

Solicitud:

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

Respuesta:

{
           "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
       }

Recuperar acciones de descubrimiento

Recuperar todas las acciones de descubrimiento configuradas junto con las condiciones y operaciones de la acción. El filtro utiliza el tipo de evaluación "y", por lo que la propiedad formula está vacía y se genera automáticamente eval_formula.