maintenance.get

Opis

integer/array maintenance.get(object parameters)

Metoda umożliwia pobieranie konserwacji zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody mogą zostać odebrane w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
groupids ID/array Zwraca tylko okresy utrzymania przypisane do podanych grup hostów.
hostids ID/array Zwraca tylko okresy utrzymania przypisane do podanych hostów.
triggerids ID/array Zwraca tylko okresy utrzymania przypisane do podanych wyzwalaczy.
maintenanceids ID/array Zwraca tylko okresy utrzymania o podanych identyfikatorach.
selectHostGroups query Zwraca właściwość hostgroups zawierającą grupy hostów przypisane do okresu utrzymania.
selectHosts query Zwraca właściwość hosts zawierającą hosty przypisane do okresu utrzymania.
selectTriggers query Zwraca właściwość triggers zawierającą wyzwalacze przypisane do okresu utrzymania.
selectEventNames query Zwraca właściwość event_names zawierającą nazwy zdarzeń przypisane do okresu utrzymania.
selectTags query Zwraca właściwość tags zawierającą znaczniki problemów okresu utrzymania.
selectTimeperiods query Zwraca właściwość timeperiods zawierającą okresy czasowe okresu utrzymania.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Te parametry opisano 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:

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

Przykłady

Pobieranie okresów utrzymania

Pobierz wszystkie skonfigurowane okresy utrzymania, dane dotyczące przypisanego zakresu okresu utrzymania (grupa hostów, host, wyzwalacz, nazwa zdarzenia, znaczniki) oraz zdefiniowane przedziały czasowe.

Żądanie:

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

Odpowiedź:


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Regular DB maintenance",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Databases",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "Ad-hoc: Printer: ink OUT",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Zabbix servers",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Printer: ink OUT"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}```

[comment]: # ({/ec7146e4-0b1cb387})

[comment]: # ({0c4dce96-dbcf678a})
### Zobacz także

-   [Host](/manual/api/reference/host/object#host)
-   [Grupa hostów](/manual/api/reference/hostgroup/object#host-group)
-   [Wyzwalacz](/manual/api/reference/trigger/object#trigger)
-   [Nazwa zdarzenia](object#event-name)
-   [Tag problemu](object#problem-tag)
-   [Okres](object#time-period)

[comment]: # ({/0c4dce96-dbcf678a})

[comment]: # ({f0ec3c40-50ed5be3})
### Źródło

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

[comment]: # ({/f0ec3c40-50ed5be3})