maintenance.get

Beschrijving

integer/array maintenance.get(object parameters)

De methode maakt het mogelijk om onderhoud op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste output definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
groupids string/array Geeft alleen onderhoud aan dat is toegewezen aan de opgegeven hostgroepen.
hostids string/array Geeft alleen onderhoud aan dat is toegewezen aan de opgegeven hosts.
maintenanceids string/array Geeft alleen onderhoud aan met de opgegeven IDs.
selectHostGroups query Geeft een hostgroups eigenschap terug met hostgroepen die aan het onderhoud zijn toegewezen.
selectHosts query Geeft een hosts eigenschap terug met hosts die aan het onderhoud zijn toegewezen.
selectTags query Geeft een tags eigenschap terug met probleemtags van het onderhoud.
selectTimeperiods query Geeft een timeperiods eigenschap terug met tijdperiodes van het onderhoud.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: maintenanceid, name, maintenance_type.
countOutput boolean Deze parameters die gemeenschappelijk zijn voor alle get methoden worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Deze parameter is verouderd, gebruik alstublieft selectHostGroups in plaats daarvan.
Geeft een groups eigenschap terug met hostgroepen die aan het onderhoud zijn toegewezen.

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Onderhoudsinstellingen ophalen

Haal alle geconfigureerde onderhoudsinstellingen op, samen met de gegevens over toegewezen hostgroepen, gedefinieerde tijdperiodes en probleemtags.

Verzoek:

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

Reactie:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "Zondag onderhoud",
            "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
}

Zie ook

Bron

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