graph.get

Opis

integer/array graph.get(object parameters)

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

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

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
graphids ID/array Zwracaj tylko grafy o podanych ID.
groupids ID/array Zwracaj tylko grafy należące do hostów lub szablonów w podanych grupach hostów lub grupach szablonów.
templateids ID/array Zwracaj tylko grafy należące do podanych szablonów.
hostids ID/array Zwracaj tylko grafy należące do podanych hostów.
itemids ID/array Zwracaj tylko grafy zawierające podane pozycje.
templated boolean Jeśli ustawione na true, zwracaj tylko grafy należące do szablonów.
inherited boolean Jeśli ustawione na true, zwracaj tylko grafy odziedziczone z szablonu.
expandName flag Rozszerz makra w nazwie grafu.
selectHostGroups query Zwróć właściwość hostgroups z grupami hostów, do których należy graf.
selectTemplateGroups query Zwróć właściwość templategroups z grupami szablonów, do których należy graf.
selectTemplates query Zwróć właściwość templates z szablonami, do których należy graf.
selectHosts query Zwróć właściwość hosts z hostami, do których należy graf.
selectItems query Zwróć właściwość items z pozycjami używanymi w grafie.
selectGraphDiscovery query Zwróć właściwość graphDiscovery z obiektem wykrywania grafu. Obiekt wykrywania grafu łączy graf z prototypem grafu, na podstawie którego został utworzony.

Ma on następujące właściwości:
graphid - (ID) ID grafu;
parent_graphid - (ID) ID prototypu grafu, na podstawie którego został utworzony graf;
lastcheck - (timestamp) czas ostatniego wykrycia grafu;
status - (int) status wykrywania grafu:
0 - (domyślnie) graf został wykryty,
1 - graf nie jest już wykrywany;
ts_delete - (timestamp) czas, po którym graf, który nie jest już wykrywany, zostanie usunięty.
selectGraphItems query Zwróć właściwość gitems z pozycjami używanymi w grafie.
selectDiscoveryRule query Zwróć właściwość discoveryRule z regułą niskopoziomowego wykrywania, która utworzyła graf.
filter object Zwracaj tylko te wyniki, które dokładnie pasują do podanego filtra.

Przyjmuje obiekt, w którym kluczami są nazwy właściwości, a wartościami pojedyncza wartość lub tablica wartości, z którymi ma zostać wykonane dopasowanie.

Nie obsługuje właściwości o typie danych text data type.

Obsługuje dodatkowe właściwości:
host - techniczna nazwa hosta, do którego należy graf;
hostid - ID hosta, do którego należy graf.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości: graphid, name, graphtype.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
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 lub selectTemplateGroups.
Zwróć właściwość groups z grupami hostów i grupami szablonów, do których należy graf.

Zwracane wartości

(integer/array) Zwraca:

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

Przykłady

Pobieranie wykresów z hostów

Pobierz wszystkie wykresy z hosta „10107” i posortuj je według nazwy.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "graph.get",
    "params": {
        "output": "extend",
        "hostids": 10107,
        "sortfield": "name"
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "612",
            "name": "CPU jumps",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "613",
            "name": "CPU load",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "614",
            "name": "CPU utilization",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "1",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "645",
            "name": "Disk space usage /",
            "width": "600",
            "height": "340",
            "yaxismin": "0",
            "yaxismax": "0",
            "templateid": "0",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "4"
        }
    ],
    "id": 1
}

Zobacz także

Źródło

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