graphprototype.get

Opis

integer/array graphprototype.get(object parameters)

Ta metoda umożliwia pobieranie prototypów 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 Rolach użytkowników.

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
discoveryids ID/array Zwracaj tylko prototypy wykresów należące do podanych reguł wykrywania.
graphids ID/array Zwracaj tylko prototypy wykresów o podanych ID.
groupids ID/array Zwracaj tylko prototypy wykresów należące do hostów lub szablonów w podanych grupach hostów lub grupach szablonów.
hostids ID/array Zwracaj tylko prototypy wykresów należące do podanych hostów.
inherited boolean Jeśli ustawione na true, zwracaj tylko prototypy wykresów odziedziczone z szablonu.
itemids ID/array Zwracaj tylko prototypy wykresów zawierające podane prototypy pozycji.
templated boolean Jeśli ustawione na true, zwracaj tylko prototypy wykresów należące do szablonów.
templateids ID/array Zwracaj tylko prototypy wykresów należące do podanych szablonów.
selectDiscoveryRule query Zwraca właściwość discoveryRule z regułą LLD, do której należy prototyp wykresu.
selectGraphItems query Zwraca właściwość gitems z elementami wykresu użytymi w prototypie wykresu.
selectHostGroups query Zwraca właściwość hostgroups 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.
selectTemplateGroups query Zwraca właściwość templategroups z grupami szablonów, do których należy prototyp wykresu.
selectTemplates query Zwraca właściwość templates z szablonami, do których należy prototyp wykresu.
filter object Zwracaj tylko te wyniki, które dokładnie pasują do podanego filtra.

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

Nie obsługuje właściwości typu text data type.

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

Możliwe wartości: graphid, name, graphtype, discovered.
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.
Zwraca właściwość groups z grupami hostów i grupami szablonów, do których należy prototyp wykresu.

Zwracane wartości

(integer/array) Zwraca:

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

Przykłady

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

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

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "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.