Documentation
Table of Contents
trigger.get
Description
integer/array trigger.get(object parameters)
La méthode permet de récupérer des déclencheurs en fonction des paramètres donnés.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| triggerids | string/array | Renvoie uniquement les déclencheurs avec les identifiants donnés. |
| groupids | string/array | Renvoie uniquement les déclencheurs appartenant aux hôtes des groupes d'hôtes donnés. |
| templateids | string/array | Renvoie uniquement les déclencheurs appartenant aux modèles donnés. |
| hostids | string/array | Renvoie uniquement les déclencheurs appartenant aux hôtes donnés. |
| itemids | string/array | Renvoie uniquement les déclencheurs contenant les éléments donnés. |
| functions | string/array | Renvoie uniquement les déclencheurs qui utilisent les fonctions données. Reportez-vous à la page Fonctions de déclencheur supportées pour une liste des fonctions prises en charge. |
| group | string | Renvoie uniquement les déclencheurs appartenant aux hôtes du groupe d'hôtes portant le nom indiqué. |
| host | string | Renvoie uniquement les déclencheurs appartenant à l'hôte avec le nom donné. |
| inherited | boolean | Si défini à true, ne renvoie que les déclencheurs hérités d'un modèle. |
| templated | boolean | Si défini à true, ne renvoie que les déclencheurs appartenant aux modèles. |
| dependent | boolean | S'il est défini sur true, ne renvoie que les déclencheurs qui ont des dépendances. S'il est défini sur false, ne renvoie que les déclencheurs qui n'ont pas de dépendances. |
| monitored | flag | Renvoie uniquement les déclencheurs activés appartenant aux hôtes surveillés et contenant uniquement des éléments activés. |
| active | flag | Renvoie uniquement les déclencheurs activés appartenant aux hôtes surveillés. |
| maintenance | boolean | Si défini à true, ne renvoie que les déclencheurs activés appartenant aux hôtes en maintenance. |
| withUnacknowledgedEvents | flag | Renvoie uniquement les déclencheurs qui ont des événements non acquittés. |
| withAcknowledgedEvents | flag | Renvoie uniquement les déclencheurs avec tous les événements acquittés. |
| withLastEventUnacknowledged | flag | Renvoie uniquement les déclencheurs avec le dernier événement non acquitté. |
| skipDependent | flag | Ignore les déclencheurs dans un état problématique qui dépendent d'autres déclencheurs. Notez que les autres déclencheurs sont ignorés s'ils sont désactivés, s'ils ont des éléments désactivés ou des hôtes d'éléments désactivés. |
| lastChangeSince | timestamp | Renvoie uniquement les déclencheurs qui ont changé d'état après le temps imparti. |
| lastChangeTill | timestamp | Renvoie uniquement les déclencheurs qui ont changé d'état avant l'heure indiquée. |
| only_true | flag | Renvoie uniquement les déclencheurs ayant récemment rencontré un problème. |
| min_severity | integer | Renvoie uniquement les déclencheurs avec une sévérité supérieure ou égale à la sévérité donnée. |
| evaltype | integer | Règles pour la recherche de tag. Valeurs possibles : 0 - (Par défaut) Et/Ou ; 2 - Ou. |
| tags | array of objects | Retourne seulement les déclencheurs avec les tags donnés. Correspondance exacte par tag et recherche par tag sensible à la casse ou non sensible à la casse selon la valeur de l'opérateur. Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide retourne tous les déclencheurs. Types d'opérateurs possibles : 0 - (par défaut) Comme ; 1 - Egal; 2 - Pas comme ; 3 - Pas égal ; 4 - Existe ; 5 - N'existe pas. |
| expandComment | flag | Développe les macros dans la description du déclencheur. |
| expandDescription | flag | Développe les macros dans le nom du déclencheur. |
| expandExpression | flag | Développe les macros et les fonctions dans l'expression du déclencheur. |
| selectGroups | query | Renvoie les groupes hôtes auxquels le déclencheur appartient dans la propriété groups. |
| selectHosts | query | Renvoie les hôtes auxquels le déclencheur appartient dans la propriété hosts. |
| selectItems | query | Renvoie les éléments contenus dans le déclencheur dans la propriété items. |
| selectFunctions | query | Renvoie les fonctions utilisées dans le déclencheur dans la propriété functions.Les objets fonction représentent les fonctions utilisées dans l'expression du déclencheur et possèdent les propriétés suivantes : functionid - (string) ID de la fonction ;itemid - (string) ID de l'élément utilisé dans la fonction ;function - (string) nom de la fonction ;parameter - (string) paramètre passé à la fonction. Le paramètre de requête est remplacé par le symbole $ dans la chaîne renvoyée. |
| selectDependencies | query | Renvoie les déclencheurs dont dépend le déclencheur dans la propriété dependencies. |
| selectDiscoveryRule | query | Renvoie la règle de découverte de bas niveau qui a créé le déclencheur. |
| selectLastEvent | query | Retourne le dernier événement déclencheur significatif dans la propriété lastEvent. |
| selectTags | query | Renvoie les tags de déclenchement dans la propriété tags. |
| selectTriggerDiscovery | query | Renvoie l'objet de découverte du déclencheur dans la propriété triggerDiscovery. Les objets de découverte de déclencheur lient le déclencheur à un prototype de déclencheur à partir duquel il a été créé.Il a les propriétés suivantes : parent_triggerid - (string) ID du prototype de déclencheur à partir duquel le déclencheur a été créé. |
| filter | object | Renvoie uniquement les résultats qui correspondent exactement au filtre donné. Accepte un tableau dans lequel les clés sont des noms de propriétés et les valeurs sont une valeur unique ou un tableau de valeurs à comparer. \\Prend en charge des filtres supplémentaires : host - nom technique de l'hôte auquel appartient le déclencheur ;hostid - ID de l'hôte auquel appartient le déclencheur. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-requêtes. S'applique aux sous-sélections suivantes : selectHosts - les résultats seront triés par host. |
| sortfield | string/array | Trie le résultat par les propriétés données. Valeurs possibles : triggerid, description, status, priority, lastchange et hostname. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes get, sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération des données par ID de déclencheur
Récupérez toutes les données et les fonctions utilisées dans le déclencheur "14062".
Requête :
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"triggerids": "14062",
"output": "extend",
"selectFunctions": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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
}Récupération des déclencheurs en état problématique
Récupérer l'ID, le nom et la sévérité de tous les déclencheurs en état problématique et les trier par sévérité en ordre décroissant.
Requête :
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description",
"priority"
],
"filter": {
"value": 1
},
"sortfield": "priority",
"sortorder": "DESC"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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
}Récupération d'un déclencheur spécifique avec des tags
Récupération d'un déclencheur spécifique avec des tags.
Requête :
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17578"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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
}Voir également
Source
CTrigger::get() dans ui/include/classes/api/services/CTrigger.php.