triggerprototype.get

Description

integer/array triggerprototype.get(object parameters)

La méthode permet de récupérer des prototypes de 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
active	flag	Renvoie uniquement les prototypes de déclencheur activés appartenant aux hôtes surveillés.
discoveryids	string/array	Renvoie uniquement les prototypes de déclencheur appartenant aux règles LLD données.
functions	string/array	Renvoie uniquement les déclencheurs qui utilisent les fonctions données. Reportez-vous à la page des fonctions de déclenchement supportées pour obtenir une liste des fonctions supportées.
group	string	Renvoie uniquement les prototypes de déclencheur appartenant aux hôtes des groupes donnés.
groupids	string/array	Renvoie uniquement les prototypes de déclencheurs appartenant aux hôtes des groupes donnés.
host	string	Renvoie uniquement les prototypes de déclencheurs appartenant aux hôtes donnés.
hostids	string/array	Renvoie uniquement les prototypes de déclencheurs appartenant aux hôtes donnés.
inherited	boolean	Si défini sur `true`, ne renvoie que les prototypes de déclencheurs hérités d'un modèle.
maintenance	boolean	Si la valeur est `true`, seuls les prototypes de déclencheurs appartenant aux hôtes en maintenance sont renvoyés.
min_severity	integer	Renvoie uniquement les prototypes de déclenchement dont la sévérité est supérieure ou égale à la sévérité donnée.
monitored	flag	Renvoie uniquement les prototypes de déclencheurs activés appartenant à des hôtes surveillés et contenant uniquement des éléments activés.
templated	boolean	Si défini sur `true`, ne renvoie que les prototypes de déclenchement appartenant aux modèles.
templateids	string/array	Renvoie uniquement les prototypes de déclencheurs appartenant aux modèles donnés.
triggerids	string/array	Renvoie uniquement les prototypes de déclencheurs avec les ID donnés.
expandExpression	flag	Développe les fonctions et les macros dans l'expression du déclencheur.
selectDependencies	query	Renvoie les prototypes de déclencheurs et les déclencheurs dont dépend le prototype de déclencheur dans la propriété `dependencies`.
selectDiscoveryRule	query	Renvoie la règle LLD à laquelle appartient le prototype de déclencheur.
selectFunctions	query	Renvoie les fonctions utilisées dans le prototype de 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.
selectGroups	query	Renvoie les groupes hôtes auxquels appartient le prototype de déclencheur dans la propriété groups.
selectHosts	query	Renvoie les hôtes auxquels appartient le prototype de déclencheur dans la propriété hosts.
selectItems	query	Retourne les éléments et les prototypes d'éléments utilisés par le prototype de déclencheur dans la propriété items.
selectTags	query	Renvoie les tags du prototype de déclenchement dans la propriété tags.
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. Prise en charge des filtres supplémentaires : `host` - nom technique de l'hôte auquel appartient le prototype de déclencheur; `hostid` - ID de l'hôte auquel appartient le prototype de 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` et `priority`.
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
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 countOutput a été utilisé.

Exemples

Récupérer des prototypes de déclencheur à partir d'une règle LLD

Récupérez tous les prototypes de déclencheur et leurs fonctions à partir d'une règle LLD.

Requête :

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.get",
           "params": {
               "output": "extend",
               "selectFunctions": "extend",
               "discoveryids": "22450"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Free inodes is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "12598",
                           "itemid": "22454",
                           "triggerid": "13272",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               },
               {
                   "triggerid": "13266",
                   "expression": "{13500}<20",
                   "description": "Free disk space is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "triggerid": "13266",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Récupération d'un prototype de déclencheur spécifique avec des tags