Documentation
Table of Contents
graph.get
Opis
integer/array graph.get(object parameters)
Metoda pozwala na pobieranie wykresów zgodnie z podanymi parametrami.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.
Parametry
(object) Parametry definiujące żądany wynik.
Metoda obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| graphids | string/array | Zwraca tylko wykresy o podanych ID. |
| groupids | string/array | Zwraca tylko wykresy należące do hostów w podanych grupach hostów. |
| templateids | string/array | Zwraca tylko wykresy należące do podanych szablonów. |
| hostids | string/array | Zwraca tylko wykresy należące do podanych hostów. |
| itemids | string/array | Zwraca tylko wykresy, które zawierają podane pozycje. |
| templated | boolean | Zwraca tylko wykresy należące do szablonów jeśli ustawione na true. |
| inherited | boolean | Zwraca tylko wykresy odziedziczone z szablonu jeśli ustawione na true. |
| expandName | flag | Rozwiń makra w nazwie wykresu. |
| selectGroups | query | Zwraca właściwość groups z grupami hostów, do których należy wykres. |
| selectTemplates | query | Zwraca właściwość templates z szablonami, do których należy wykres. |
| selectHosts | query | Zwraca właściwość hosts z hostami, do których należy wykres. |
| selectItems | query | Zwraca właściwość items z pozycjami użytymi na wykresie. |
| selectGraphDiscovery | query | Zwraca właściwość graphDiscovery z obiektem wykrytych wykresów. Obiekty wykrytych wykresów łączą wykres z prototypem wykresu, na podstawie którego został utworzony.Ma on następujące właściwości: graphid - (string) ID wykresu;parent_graphid - (string) Identyfikator prototypu wykresu, z którego został utworzony wykres. |
| selectGraphItems | query | Zwraca właściwość gitems z pozycjami użytymi na wykresie. |
| selectDiscoveryRule | query | Zwraca właściwość discoveryRule z niskopoziomową regułą wykrywania, która utworzyła wykres. |
| filter | object | Zwraca tylko te wyniki, które dokładnie pasują do podanego filtra. Akceptuje tablicę, w której klucze są nazwami właściwości, a wartości są albo pojedynczą wartością, albo tablicą wartości do dopasowania. Obsługuje dodatkowe filtry: host - nazwa techniczna hosta do którego należy wykres;hostid - ID hosta do którego należy wykres. |
| sortfield | string/array | Sortuj wynik według podanych właściwości. Możliwe wartości to: graphid, name i graphtype. |
| countOutput | boolean | Te parametry wspólne dla wszystkich metod get zostały 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 |
Zwracane wartości
(integer/array) Zwraca jedną z opcji:
- tablicę obiektów;
- liczbę pobranych obiektów, jeśli parametr
countOutputzostał wykorzystany.
Przykłady
Pobieranie wykresów z hostów
Pobiera wszystkie wykresy z hosta "10107" i sortuje we według nazwy.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "graph.get",
"params": {
"output": "extend",
"hostids": 10107,
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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.