action.get

Descripción

integer/array action.get(parámetros de objeto)

El método permite recuperar acciones según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Para más información, ver Roles de usuario.

Parámetros

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

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
actionids ID/array Devuelve sólo acciones con los ID proporcionados.
groupids ID/matriz Devuelve sólo acciones que utilizan los grupos de equipos dados en condiciones de acción.
hostids ID/matriz Devuelve sólo acciones que utilizan los equipos dados en condiciones de acción.
triggerids ID/matriz Devuelve sólo acciones que utilizan los iniciadores dados en las condiciones de acción.
mediatypeids ID/matriz Devuelve solo acciones que utilizan los tipos de medios dados para enviar mensajes.
usrgrpids ID/matriz Devuelve sólo acciones que están configuradas para enviar mensajes a los grupos de usuarios dados.
userids ID/matriz Devuelve sólo acciones que están configuradas para enviar mensajes a los usuarios dados.
scriptids ID/matriz Devuelve sólo acciones que están configuradas para ejecutar los scripts dados.
selectFilter query Devuelve una propiedad filter con el filtro de condición de acción.
selectOperations query Devuelve una propiedad operations 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.

Valores posibles: actionid, name, 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:

  • 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
       }
       },
       "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 eval_formula automáticamente.

Solicitud:

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

Respuesta:

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

Ver también

Fuente

CAction::get() en ui/include/clases/api/services/CAction.php.