problem.get

Description

integer/array problem.get(object parameters)

La méthode permet de récupérer les problèmes selon les paramètres donnés.

Cette méthode sert à récupérer les problèmes non résolus. Il est également possible, si cela est spécifié, de récupérer en plus les problèmes récemment résolus. La période qui détermine ce que signifie "récemment" est définie dans Administration > Général. Les problèmes résolus avant cette période ne sont pas conservés dans la table des problèmes. Pour récupérer des problèmes résolus plus loin dans le passé, utilisez la méthode event.get.

Cette méthode peut renvoyer des problèmes d'une entité supprimée si ces problèmes n'ont pas encore été supprimés par le housekeeper.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez 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.

Parameter Type Description
eventids ID/array Ne retourner que les problèmes avec les IDs donnés.
groupids ID/array Ne retourner que les problèmes créés par des objets appartenant aux groupes d'hôtes donnés.
hostids ID/array Ne retourner que les problèmes créés par des objets appartenant aux hôtes donnés.
objectids ID/array Ne retourner que les problèmes créés par les objets donnés.
source integer Ne retourner que les problèmes du type donné.

Consultez la page de l'objet d'événement de problème pour obtenir la liste des types d'événements pris en charge.

Par défaut: 0 - problème créé par un déclencheur.
object integer Ne retourner que les problèmes créés par des objets du type donné.

Consultez la page de l'objet d'événement de problème pour obtenir la liste des types d'objets pris en charge.

Par défaut: 0 - déclencheur.
acknowledged boolean Si défini sur true, ne retourner que les problèmes reconnus.
action integer Ne retourner que les problèmes pour lesquels les actions de mise à jour d'événement données ont été effectuées. Pour plusieurs actions, utilisez une somme de toutes les valeurs de bitmap acceptables comme masque de bits (par exemple, 34 pour reconnaître et supprimer l'événement).
action_userids ID/array Ne retourner que les problèmes avec les IDs donnés des utilisateurs qui ont effectué les actions de mise à jour de l'événement de problème.
suppressed boolean Si défini sur true, ne retourner que les problèmes supprimés.
symptom boolean Si défini sur true, ne retourner que les événements de problème symptomatiques.
severities integer/array Ne retourner que les problèmes avec les sévérités d'événement données. S'applique uniquement si object est déclencheur.
evaltype integer Méthode d'évaluation des balises.

Valeurs possibles:
0 - (par défaut) Et/Ou;
2 - Ou.
tags array Ne retourner que les problèmes avec les balises données.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne tous les problèmes.

Valeurs possibles de operator:
0 - (par défaut) Contient;
1 - Égal à;
2 - Ne contient pas;
3 - N'est pas égal à;
4 - Existe;
5 - N'existe pas.
recent boolean Si défini sur true, retourner les problèmes récents, y compris ceux résolus dans la période ok_period et tous les problèmes non résolus.
Si défini sur false, ne retourner que les problèmes non résolus.
eventid_from string Ne retourner que les problèmes avec des IDs supérieurs ou égaux à l'ID donné.
eventid_till string Ne retourner que les problèmes avec des IDs inférieurs ou égaux à l'ID donné.
time_from timestamp Ne retourner que les problèmes qui ont été créés après ou à l'heure donnée.
time_till timestamp Ne retourner que les problèmes qui ont été créés avant ou à l'heure donnée.
selectAcknowledges query Retourner une propriété acknowledges avec les mises à jour du problème. Les mises à jour du problème sont triées en ordre chronologique inverse.

L'objet de mise à jour du problème possède les propriétés suivantes:
acknowledgeid - (ID) ID de la mise à jour;
userid - (ID) ID de l'utilisateur qui a mis à jour l'événement;
eventid - (ID) ID de l'événement mis à jour;
clock - (timestamp) heure à laquelle l'événement a été mis à jour;
message - (string) texte du message;
action - (integer) type d'action de mise à jour (voir event.acknowledge);
old_severity - (integer) sévérité de l'événement avant cette action de mise à jour;
new_severity - (integer) sévérité de l'événement après cette action de mise à jour;
suppress_until - (timestamp) heure jusqu'à laquelle l'événement sera supprimé;
taskid - (ID) ID de la tâche si l'événement actuel est en cours de changement de rang;
maintenanceid - (ID) ID de la maintenance.

Prend en charge count.
selectTags query Retourner une propriété tags avec les balises du problème. Format de sortie: [{"tag": "<tag>", "value": "<value>"}, ...].
selectSuppressionData query Retourner une propriété suppression_data avec la liste des maintenances actives et des suppressions manuelles:
maintenanceid - (ID) ID de la maintenance;
userid - (ID) ID de l'utilisateur qui a supprimé le problème;
suppress_until - (integer) heure jusqu'à laquelle le problème est supprimé.
filter object Ne retourner que les résultats qui correspondent exactement au filtre donné.

Accepte un objet, où les clés sont des noms de propriétés et les valeurs sont soit une seule valeur, soit un tableau de valeurs à comparer.

Ne prend pas en charge les propriétés de type de données data type text.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles: eventid.
countOutput boolean Ces paramètres sont décrits dans la commentaire 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 de retour

(integer/array) Renvoie soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des événements de problème du déclencheur

Récupérer les événements récents du déclencheur "15112."

Requête :

{
    "jsonrpc": "2.0",
    "method": "problem.get",
    "params": {
        "output": "extend",
        "selectAcknowledges": "extend",
        "selectTags": "extend",
        "selectSuppressionData": "extend",
        "objectids": "15112",
        "recent": true,
        "sortfield": ["eventid"],
        "sortorder": "DESC"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "1245463",
            "source": "0",
            "object": "0",
            "objectid": "15112",
            "clock": "1472457242",
            "ns": "209442442",
            "r_eventid": "1245468",
            "r_clock": "1472457285",
            "r_ns": "125644870",
            "correlationid": "0",
            "userid": "1",
            "name": "Zabbix agent on localhost is unreachable for 5 minutes",
            "acknowledged": "1",
            "severity": "3",
            "cause_eventid": "0",
            "suppressed": "1",
            "acknowledges": [
                {
                    "acknowledgeid": "14443",
                    "userid": "1",
                    "eventid": "1245463",
                    "clock": "1472457281",
                    "message": "problem solved",
                    "action": "6",
                    "old_severity": "0",
                    "new_severity": "0",
                    "suppress_until": "1472511600",
                    "taskid": "0",
                    "maintenanceid": "0"
                }
            ],
            "opdata": "",
            "suppression_data": [
                {
                    "maintenanceid": "15",
                    "suppress_until": "1472511600",
                    "userid": "0"
                }
            ],
            "tags": [
                {
                    "tag": "test-tag",
                    "value": "test-value"
                }
            ],
            "urls": []
        }
    ],
    "id": 1
}

Récupération des problèmes reconnus par un utilisateur spécifié

Récupération des problèmes reconnus par l'utilisateur avec l'ID=10

Requête :

{
    "jsonrpc": "2.0",
    "method": "problem.get",
    "params": {
        "output": "extend",
        "action": 2,
        "action_userids": [10],
        "selectAcknowledges": ["userid", "action"],
        "sortfield": ["eventid"],
        "sortorder": "DESC"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "1248566",
            "source": "0",
            "object": "0",
            "objectid": "15142",
            "clock": "1472457242",
            "ns": "209442442",
            "r_eventid": "1245468",
            "r_clock": "1472457285",
            "r_ns": "125644870",
            "correlationid": "0",
            "userid": "10",
            "name": "Zabbix agent on localhost is unreachable for 5 minutes",
            "acknowledged": "1",
            "severity": "3",
            "cause_eventid": "0",
            "suppressed": "0",
            "acknowledges": [
                {
                    "acknowledgeid": "9",
                    "userid": "10",
                    "action": "2"
                }
            ],
            "opdata": "",
            "urls": []
        }
    ],
    "id": 1
}

Voir aussi

Source

CEvent::get() dans ui/include/classes/api/services/CProblem.php.