trigger.get

Descripción

entero/matriz trigger.get(parámetros de objeto)

El método permite recuperar iniciadores de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles 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
triggerids cadena/matriz Devuelve solo activadores con los ID proporcionados.
groupids cadena/matriz Devuelve solo activadores que pertenecen a hosts de los grupos de hosts dados.
templateids cadena/matriz Devuelve solo activadores que pertenecen a las plantillas dadas.
hostids cadena/matriz Devuelve solo activadores que pertenecen a los hosts dados.
itemids string/array Devuelve solo activadores que contienen los elementos dados.
funciones cadena/matriz Devuelve solo activadores que usan las funciones dadas.

Consulte la página función admitida para obtener una lista de funciones admitidas.
grupo cadena Devuelve solo activadores que pertenecen a hosts del grupo de hosts con el nombre dado.
host cadena Devuelve sólo los activadores que pertenecen al host con el nombre técnico proporcionado.
heredado booleano Si se establece en "verdadero", solo se devuelven activadores heredados de una plantilla.
templado booleano Si se establece en "verdadero", solo se devuelven activadores que pertenecen a plantillas.
dependiente booleano Si se establece en "verdadero", devuelve solo los activadores que tienen dependencias. Si se establece en "falso", solo se devuelven activadores que no tengan dependencias.
monitored flag Devuelve solo activadores habilitados que pertenecen a hosts monitoreados y que contienen solo elementos habilitados.
active flag Devuelve sólo los activadores habilitados que pertenecen a hosts monitoreados.
mantenimiento booleano Si se establece en "verdadero", solo se devuelven activadores habilitados que pertenecen a hosts en mantenimiento.
withUnacknowledgedEvents flag Devuelve solo activadores que tienen eventos no reconocidos.
withAcknowledgedEvents flag Devuelve solo activadores con todos los eventos reconocidos.
withLastEventUnacknowledged flag Devuelve solo activadores con el último evento no reconocido.
skipDependent flag Omitir activadores en un estado de problema que dependen de otros activadores. Tenga en cuenta que los otros activadores se ignoran si están deshabilitados, tienen elementos deshabilitados o hosts de elementos deshabilitados.
lastChangeSince marca de tiempo Devuelve solo los activadores que han cambiado su estado después del tiempo dado.
lastChangeTill timestamp Devuelve solo los activadores que han cambiado su estado antes del tiempo indicado.
only_true flag Devuelve sólo los activadores que recientemente han estado en un estado problemático.
min_severity integer Devuelve solo desencadenadores con una gravedad mayor o igual que la gravedad dada.
evaltype integer Reglas para la búsqueda de etiquetas.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
etiquetas matriz de objetos Devuelve solo activadores con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...].
Una matriz vacía devuelve todos los activadores.

Tipos de operadores posibles:
0 - (predeterminado) Me gusta;
1 - Igual;
2 - No me gusta;
3 - No igual
4 - Existe;
5 - No existe.
expandComment flag Ampliar macros en la descripción del activador.
expandDescription flag Ampliar macros en el nombre del activador.
expandExpression flag Ampliar funciones y macros en la expresión desencadenante.
selectGroups query Devuelve los grupos de hosts a los que pertenece el activador en la propiedad groups.
selectHosts query Devuelve los hosts a los que pertenece el activador en la propiedad hosts.
selectItems query Devuelve los elementos contenidos por el activador en la propiedad items.
selectFunctions query Devuelve funciones utilizadas en el activador en la propiedad functions.

Los objetos de función representan las funciones utilizadas en la expresión del activador y tienen las siguientes propiedades:
functionid - ( string) ID de la función;
itemid - (string) ID del elemento utilizado en la función;
function - (string) nombre de la función;
parámetro - (cadena) parámetro pasado a la función. El parámetro de consulta se reemplaza por el símbolo $ en la cadena devuelta.
selectDependencies query Devuelve los disparadores de los que depende el disparador en la propiedad dependencias.
selectDiscoveryRule query Devuelve la regla de descubrimiento de bajo nivel que creó el activador.
selectLastEvent query Devuelve el último evento desencadenante significativo en la propiedad lastEvent.
selectTags query Devuelve las etiquetas de activación en la propiedad tags.
selectTriggerDiscovery query Devuelve el objeto de descubrimiento desencadenante en la propiedad triggerDiscovery. Los objetos de descubrimiento del disparador vinculan el disparador a un prototipo del disparador a partir del cual se creó.

Tiene las siguientes propiedades:
parent_triggerid - (cadena) ID del prototipo del disparador desde donde se originó el disparador. ha sido creado.
filtro objeto Devuelve sólo aquellos resultados que coinciden exactamente con el filtro dado.

Acepta una matriz, donde las claves son nombres de propiedades y los valores son un valor único o una matriz de valores con los que comparar.

Admite filtros adicionales:
host: nombre técnico del host al que pertenece el activador;
hostid: ID del host al que pertenece el activador.
limitSelects integer Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
selectHosts: los resultados se ordenarán por host.
sortfield string/array Ordenar el resultado según las propiedades dadas.

Los valores posibles son: triggerid, description, status, prioridad, último cambio y nombre de host.
countOutput boolean Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página comentario de referencia.
editable booleano
excluirBuscar booleano
límite entero
salida consulta
preservekeys booleano
buscar objeto
searchByAny booleano
searchWildcardsEnabled booleano
clasificación cadena/matriz
iniciarBuscar booleano

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar datos por ID de activador

Recupere todos los datos y las funciones utilizadas en el iniciador "14062".

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "triggerids": "14062",
               "output": "extend",
               "selectFunctions": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "14062",
                   "expression": "{13513}<10m",
                   "description": "{HOST.NAME} has been restarted (uptime < 10m)",
                   "url": "",
                   "status": "0",
                   "value": "0",
                   "priority": "2",
                   "lastchange": "0",
                   "comments": "The host uptime is less than 10 minutes",
                   "error": "",
                   "templateid": "10016",
                   "type": "0",
                   "state": "0",
                   "flags": "0",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "functions": [
                       {
                           "functionid": "13513",
                           "itemid": "24350",
                           "triggerid": "14062",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recuperar iniciadores en estado de problema

Recupere el ID, el nombre y la gravedad de todos los iniciadores en estado de problema y ordénelos por gravedad en orden descendente.

Solicitud:

{
       "jsonrpc": "2.0",
       "method": "trigger.get",
       "params": {
       "output": [
       "triggerid",
       "description",
       "priority"
       ],
       "filter": {
       "value": 1
       },
       "sortfield": "priority",
       "sortorder": "DESC"
       },
       "id": 1
       }

Respuesta:

{
       "jsonrpc": "2.0",
       "result": [
       {
       "triggerid": "13907",
       "description": "Zabbix self-monitoring processes < 100% busy",
       "priority": "4"
       },
       {
       "triggerid": "13824",
       "description": "Zabbix discoverer processes more than 75% busy",
       "priority": "3"
       }
       ],
       "id": 1
       }

Recuperar un iniciador específico con etiquetas

Recupera un iniciador específico con etiquetas.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "output": [
                   "triggerid",
                   "description"
               ],
               "selectTags": "extend",
               "triggerids": [
                   "17578"
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "17370",
                   "description": "Service status",
                   "tags": [
                       {
                           "tag": "service",
                           "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                       },
                       {
                           "tag": "error",
                           "value": ""
                       }
                   ]
               }
           ],
           "id": 1
       }

Ver también

Fuente

CTrigger::get() en ui/include/classes/api/services/CTrigger.php.