graphprototype.get

Opis

integer/array graphprototype.get(object parameters)

Metoda pozwala na pobranie prototypu wykresu 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
discoveryids	string/array	Zwraca tylko te prototypy wykresów, które należą do podanych reguł wykrywania.
graphids	string/array	Zwraca tylko prototypy wykresów o podanych identyfikatorach.
groupids	string/array	Zwraca tylko prototypy wykresów, które należą do hostów w podanych grupach hostów.
hostids	string/array	Zwraca tylko prototypy wykresów, które należą do podanych hostów.
inherited	boolean	zwraca tylko prototypy wykresów odziedziczone z szablonu jeśli ustawione na `true`.
itemids	string/array	Zwraca tylko te prototypy wykresów, które zawierają podane prototypy pozycji.
templated	boolean	zwraca tylko prototypy wykresów należące do szablonów, jeśli ustawione na`true`.
templateids	string/array	Zwraca tylko te prototypy wykresów, które należą do podanych szablonów.
selectDiscoveryRule	query	Zwraca właściwość discoveryRulez regułą LLD, do której należy prototyp wykresu.
selectGraphItems	query	Zwraca właściwość gitems z pozycjami wykresu użytymi w prototypie wykresu.
selectGroups	query	Zwraca właściwość groups z grupami hostów, do których należy prototyp wykresu.
selectHosts	query	Zwraca właściwość hosts z hostami, do których należy prototyp wykresu.
selectItems	query	Zwraca właściwość `items` z pozycjami i prototypami pozycji użytymi w prototypie wykresu.
selectTemplates	query	Zwraca właściwość templates z szablonami, do których należy prototyp wykresu.
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 prototyp wykresu; `hostid` - identyfikator hosta, do którego należy prototyp wykresu.
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 countOutput został wykorzystany.

Przykłady

Pobieranie prototypów wykresów z reguły LLD

Pobierz wszystkie prototypy wykresów z reguły LLD.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "graphprototype.get",
           "params": {
               "output": "extend",
               "discoveryids": "27426"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "1017",
                   "parent_itemid": "27426",
                   "name": "Disk space usage {#FSNAME}",
                   "width": "600",
                   "height": "340",
                   "yaxismin": "0.0000",
                   "yaxismax": "0.0000",
                   "templateid": "442",
                   "show_work_period": "0",
                   "show_triggers": "0",
                   "graphtype": "2",
                   "show_legend": "1",
                   "show_3d": "1",
                   "percent_left": "0.0000",
                   "percent_right": "0.0000",
                   "ymin_type": "0",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "discover": "0"
               }
           ],
           "id": 1
       }

Zobacz także

Źródło

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

Documentation