maintenance.get

Opis

integer/array maintenance.get(object parameters)

Metoda umożliwia pobieranie okresów utrzymania zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody mogą zostać cofnięte w ustawieniach ról użytkownika. Zobacz Role użytkownika aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
groupids string/array Zwraca tylko okresy utrzymania przypisane do podanych grup hostów.
hostids string/array Zwraca tylko okresy utrzymania przypisane do podanych hostów.
maintenanceids string/array Zwraca tylko okresy utrzymania o podanych identyfikatorach.
selectGroups query Zwraca właściwość groups z grupami hostów przypisanymi do okresu utrzymania.
selectHosts query Zwraca właściwość hosts z hostami przypisanymi do okresu utrzymania.
selectTags query Zwraca właściwość tags z znacznikami problemów okresu utrzymania.
selectTimeperiods query Zwraca właściwość timeperiods z okresami czasu okresu utrzymania.
sortfield string/array Sortuje wynik według podanych właściwości.

Dopuszczalne wartości to: maintenanceid, name i maintenance_type.
countOutput boolean Te parametry, będąc wspólne dla wszystkich metod get, są szczegółowo opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie okresów utrzymania

Pobierz wszystkie skonfigurowane okresy utrzymania oraz dane o przypisanych grupach hostów, zdefiniowanych okresach czasu i znacznikach problemów.

Zapytanie:

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

Odpowiedź:

{
           "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
       }

Zobacz także

Źródło

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