Documentation
Table of Contents
trigger.get
Descripción
integer/array trigger.get(object parameters)
El método permite recuperar iniciadores según 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. Para más información, consulte 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 |
|---|---|---|
| triggerids | cadena/matriz | Devuelve solo iniciadores con los ID proporcionados. |
| groupids | cadena/matriz | Devuelve solo iniciadores que pertenecen a equipos o plantillas de los grupos de equipos o grupos de plantillas dados. |
| templateids | cadena/matriz | Devuelve solo iniciadores que pertenecen a las plantillas dadas. |
| hostids | cadena/matriz | Devuelve solo iniciadores que pertenecen a los equipos dados. |
| itemids | string/array | Devuelve solo iniciadores que contienen las métricas dadas. |
| functions | cadena/matriz | Devuelve solo iniciadores que usan las funciones dadas. Consulte la página función admitida para obtener una lista de funciones admitidas. |
| group | cadena | Devuelve solo iniciadores que pertenecen a equipos o plantillas del grupo de equipos o grupo de plantillas con el nombre dado. |
| host | cadena | Devuelve solo los iniciadores que pertenecen al equipo con el nombre dado. |
| inherited | booleano | Si se establece en "verdadero", solo se devuelven iniciadores heredados de una plantilla. |
| templated | booleano | Si se establece en "verdadero", solo se devuelven iniciadores que pertenecen a plantillas. |
| dependent | booleano | Si se establece en "verdadero", devuelve solo los iniciadores que tienen dependencias. Si se establece en "falso", solo se devuelven iniciadores que no tengan dependencias. |
| monitored | flag | Devuelve solo iniciadores habilitados que pertenecen a equipos monitoreados y que contienen solo elementos habilitados. |
| active | flag | Devuelve sólo los iniciadores habilitados que pertenecen a equipos monitoreados. |
| maintenance | booleano | Si se establece en "verdadero", devolverá solo los iniciadores habilitados que pertenecen a los equipos en mantenimiento. |
| withUnacknowledgedEvents | flag | Devuelve solo iniciadores que tienen eventos no reconocidos. |
| withAcknowledgedEvents | flag | Devuelve solo iniciadores con todos los eventos reconocidos. |
| withLastEventUnacknowledged | flag | Devuelve solo iniciadores con el último evento no reconocido. |
| skipDependent | flag | Omitir iniciadores en un estado de problema que dependen de otros iniciadores. Tenga en cuenta que los otros iniciadores se ignoran si están deshabilitados, tienen métricas deshabilitadas o equipos de métricas deshabilitados. |
| lastChangeSince | marca de tiempo | Devuelve solo los iniciadores que han cambiado su estado después del tiempo dado. |
| lastChangeTill | timestamp | Devuelve solo los iniciadores que han cambiado su estado antes del tiempo indicado. |
| only_true | flag | Devuelve sólo los iniciadores que recientemente han estado en un estado de problema. |
| min_severity | integer | Devuelve solo iniciadores 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. |
| tags | matriz de objetos | Devuelve solo iniciadores con las 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 iniciadores. Tipos de operadores posibles: 0 - (predeterminado) Like; 1 - Igual; 2 - Not like; 3 - No igual 4 - Existe; 5 - No existe. |
| expandComment | flag | Ampliar macros en la descripción del iniciador. |
| expandDescription | flag | Ampliar macros en el nombre del iniciador. |
| expandExpression | flag | Ampliar funciones y macros en la expresión desencadenante. |
| selectHostGroups | query | Devuelve los grupos de equipos a los que pertenece el iniciador en la propiedad hostgroups. |
| selectHosts | query | Devuelve los equipos a los que pertenece el iniciador en la propiedad host. |
| selectItems | query | Devuelve las métricas contenidos por el iniciador en la propiedad item. |
| selectFunctions | query | Devuelve funciones utilizadas en el iniciador en la propiedad functions.Los objetos de función representan las funciones utilizadas en la expresión del iniciador y tienen las siguientes propiedades: functionid - ( string) ID de la función;itemid - (string) ID de la métrica utilizado en la función;function - (string) nombre de la función;parámetro - parámetro (cadena) pasado a la función. El parámetro de consulta se reemplaza por el símbolo $ en la cadena devuelta. |
| selectDependencies | query | Devuelve los iniciadores de los que depende el iniciador en la propiedad dependencies. |
| selectDiscoveryRule | query | Devuelve la regla de descubrimiento de bajo nivel que creó el iniciador. |
| selectLastEvent | query | Devuelve el último evento desencadenante significativo en la propiedad lastEvent. |
| selectTags | query | Devuelve las etiquetas de activación en la propiedad tags. |
| selectTemplateGroups | query | Devuelve los grupos de plantillas a los que pertenece el iniciador en la propiedad templategroups. |
| selectTriggerDiscovery | query | Devuelve el objeto de descubrimiento desencadenante en la propiedad triggerDiscovery. Los objetos de descubrimiento del iniciador vinculan el iniciador al prototipo de iniciador a partir del cual se creó.Tiene las siguientes propiedades: parent_triggerid - (cadena) ID del prototipo del iniciador desde donde se originó el iniciador. ha sido creado. |
| filter | 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 equipo al que pertenece el iniciador;hostid: ID del host al que pertenece el iniciador. |
| 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 por las propiedades dadas. Valores posibles: triggerid, description, status, priority, último cambio, 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 | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | booleano | |
| startSearch | boolean | |
| selectGroups (obsoleto) |
query | Este parámetro está obsoleto; utilice selectHostGroups o selectTemplateGroups en su lugar.Devuelve los grupos de equipos y los grupos de plantillas a los que pertenece el iniciador en la propiedad groups. |
Valores de retorno
(entero/matriz) Devuelve:
- una variedad de objetos;
- el recuento de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar datos por ID de iniciador
Recupera todos los datos y las funciones utilizadas en el iniciador "14062".
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"triggerids": "14062",
"output": "extend",
"selectFunctions": "extend"
},
"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": "",
"event_name": "",
"uuid": "",
"url_name": "",
"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.
{
"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.
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17578"
]
},
"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.