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 uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
groupids string/array Retourneer alleen onderhoud dat is toegewezen aan de opgegeven hostgroepen.
hostids string/array Retourneer alleen onderhoud dat is toegewezen aan de opgegeven hosts.
maintenanceids string/array Retourneer alleen onderhoud met de opgegeven ID's.
selectGroups query Retourneer een eigenschap groups met hostgroepen die zijn toegewezen aan het onderhoud.
selectHosts query Retourneer een eigenschap hosts met hosts die zijn toegewezen aan het onderhoud.
selectTags query Retourneer een tags eigenschap met probleemtags van het onderhoud.
selectTimeperiods query Retourneer een eigenschap timeperiods met de perioden van het onderhoud.
sortfield string/array Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn: maintenanceid, name en maintenance_type.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Onderhoud ophalen

Haal alle geconfigureerde onderhoudsbeurten op, en de gegevens over de toegewezen hostgroepen, gedefinieerde tijdsperioden en probleemtags.

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "maintenance.get",
           "params": {
               "output": "extend",
               "selectGroups": "extend",
               "selectTimeperiods": "extend",
               "selectTags": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Antwoord:

{
           "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": [
                       {
                           "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.