maintenance.get

Opis

integer/array maintenance.get(object parameters)

Ta metoda umożliwia pobieranie okresów konserwacji zgodnie z podanymi parametrami.

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

Parametry

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

Metoda obsługuje następujące parametry.

Parameter Type Description
groupids ID/array Zwracaj tylko maintenance przypisane do podanych grup hostów.
hostids ID/array Zwracaj tylko maintenance przypisane do podanych hostów.
maintenanceids ID/array Zwracaj tylko maintenance o podanych identyfikatorach.
selectHostGroups query Zwróć właściwość hostgroups z grupami hostów przypisanymi do maintenance.
selectHosts query Zwróć właściwość hosts z hostami przypisanymi do maintenance.
selectTags query Zwróć właściwość tags z tagami problemów maintenance.
selectTimeperiods query Zwróć właściwość timeperiods z okresami czasu maintenance.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Te parametry są 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
selectGroups
(deprecated)		 query Ten parametr jest przestarzały, użyj zamiast niego selectHostGroups.
Zwróć właściwość groups z grupami hostów przypisanymi do maintenance.

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 konserwacji

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

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "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",
            "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
}

Zobacz także

Źródło

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