maintenance.get

Description

integer/array maintenance.get(object parameters)

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

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. Voir User roles 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
groupids ID/array Retourner uniquement les maintenances affectées aux groupes d'hôtes donnés.
hostids ID/array Retourner uniquement les maintenances affectées aux hôtes donnés.
maintenanceids ID/array Retourner uniquement les maintenances ayant les ID donnés.
selectHostGroups query Retourner une propriété hostgroups avec les groupes d'hôtes affectés à la maintenance.
selectHosts query Retourner une propriété hosts avec les hôtes affectés à la maintenance.
selectTags query Retourner une propriété tags avec les tags de problème de la maintenance.
selectTimeperiods query Retourner une propriété timeperiods avec les périodes de temps de la maintenance.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Ces paramètres sont décrits dans le commentaire 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 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 maintenances

Récupérez toutes les maintenances configurées, ainsi que les données sur les groupes d’hôtes assignés, les périodes de temps définies et les tags de problème.

Requête:

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "Sunday maintenance",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "hostgroups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "flags": "0",
                    "uuid": "6f6799aa69e844b4b3918f779f2abf08"
                }
            ],
            "timeperiods": [
                {
                    "timeperiod_type": "3",
                    "every": "1",
                    "month": "0",
                    "dayofweek": "1",
                    "day": "0",
                    "start_time": "64800",
                    "period": "3600",
                    "start_date": "2147483647"
                }
            ],
            "tags": [
                {
                    "tag": "service",
                    "operator": "0",
                    "value": "mysqld",
                },
                {
                    "tag": "error",
                    "operator": "2",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

Voir également

Source

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