maintenance.get

Description

integer/array maintenance.get(object parameters)

La méthode permet de récupérer des maintenances en fonction des paramètres donnés.

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 string/array Renvoie uniquement les maintenances affectées aux groupes d'hôtes donnés.
hostids string/array Renvoie uniquement les maintenances affectées aux hôtes donnés.
maintenanceids string/array Renvoie uniquement les maintenances avec les identifiants donnés.
selectGroups query Renvoie les groupes d'hôtes affectés à la maintenance dans la propriété groups.
selectHosts query Renvoie les hôtes affectés à la maintenance dans la propriété hosts.
selectTimeperiods query Renvoie les périodes de la maintenance dans la propriété timeperiods.
selectTags query Retourne le tag de problème de la maintenance dans la propriété tags.
sortfield string/array Trier le résultat par les propriétés données.

Les valeurs possibles sont: userid et alias.
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 countOutput a été utilisé.

Exemples

Récupération des maintenances

Récupérer toutes les maintenances configurées, ainsi que les données relatives aux groupes d'hôtes attribués, définir les périodes et les tags de problème.

Requête :

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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",
            "groups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "internal": "0"
                }
            ],
            "timeperiods": [
                {
                    "timeperiodid": "4",
                    "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 frontends/php/include/classes/api/services/CMaintenance.php.