itemprototype.get

Opis

integer/array itemprototype.get(object parameters)

Metoda umożliwia pobranie prototypów pozycji zgodnie z podanymi parametrami.

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

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
discoveryids ID/array Zwraca tylko prototypy pozycji należące do podanych reguł LLD.
graphids ID/array Zwraca tylko prototypy pozycji używane w podanych prototypach wykresów.
hostids ID/array Zwraca tylko prototypy pozycji należące do podanych hostów.
inherited boolean Jeśli ustawiono true, zwraca tylko prototypy pozycji odziedziczone z szablonu.
itemids ID/array Zwraca tylko prototypy pozycji o podanych identyfikatorach.
monitored boolean Jeśli ustawiono true, zwraca tylko włączone prototypy pozycji należące do monitorowanych hostów.
templated boolean Jeśli ustawiono true, zwraca tylko prototypy pozycji należące do szablonów.
templateids ID/array Zwraca tylko prototypy pozycji należące do podanych szablonów.
triggerids ID/array Zwraca tylko prototypy pozycji używane w podanych prototypach wyzwalaczy.
selectDiscoveryData query Zwraca właściwość discoveryData zawierającą dane obiektu wykrywania prototypu pozycji. Obiekt wykrywania prototypu pozycji łączy wykryty prototyp pozycji z prototypem pozycji, na podstawie którego został wykryty.

Zawiera następujące właściwości:
parent_itemid - (string) identyfikator prototypu pozycji, na podstawie którego utworzono prototyp pozycji;
key_ - (string) klucz prototypu pozycji;
status - (int) status wykrywania prototypu pozycji:
0 - (domyślnie) prototyp pozycji został wykryty,
1 - prototyp pozycji nie jest już wykrywany;
ts_delete - (timestamp) czas, w którym prototyp pozycji, który nie jest już wykrywany, zostanie usunięty;
ts_disable - (timestamp) czas, w którym prototyp pozycji, który nie jest już wykrywany, zostanie wyłączony;
disable_source - (int) wskaźnik określający, czy prototyp pozycji został wyłączony przez regułę LLD, czy ręcznie:
0 - (domyślnie) wyłączony automatycznie,
1 - wyłączony przez regułę LLD.
selectDiscoveryRule query Zwraca właściwość discoveryRule zawierającą regułę wykrywania niskopoziomowego, do której należy prototyp pozycji.
selectDiscoveryRulePrototype query Zwraca właściwość discoveryRulePrototype zawierającą nadrzędny prototyp reguły LLD, do którego należy prototyp pozycji.
selectGraphs query Zwraca właściwość graphs zawierającą prototypy wykresów, w których używany jest prototyp pozycji.

Obsługuje count.
selectHosts query Zwraca właściwość hosts zawierającą tablicę hostów, do których należy prototyp pozycji.
selectInheritedTags query Zwraca właściwość inheritedTags zawierającą znaczniki znajdujące się na szablonie/hoście/połączonych szablonach.
selectTags query Zwraca znaczniki prototypu pozycji we właściwości tags.
selectTriggers query Zwraca właściwość triggers zawierającą prototypy wyzwalaczy, w których używany jest prototyp pozycji.

Obsługuje count.
selectPreprocessing query Zwraca właściwość preprocessing zawierającą opcje przetwarzania wstępnego prototypu pozycji.
selectValueMap query Zwraca właściwość valuemap zawierającą mapę wartości prototypu pozycji.
filter object Zwraca tylko wyniki dokładnie pasujące do podanego filtra.

Przyjmuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są pojedyncze wartości lub tablice wartości, do których należy dopasować wyniki.

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

Obsługuje dodatkowe właściwości:
host - techniczna nazwa hosta, do którego należy prototyp pozycji.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań:
selectGraphs - wyniki zostaną posortowane według name;
selectTriggers - wyniki zostaną posortowane według description.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: itemid, name, key_, delay, type, status, history, trends, discovered.
countOutput boolean Parametry te opisano 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:

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

Przykłady

Pobieranie prototypów pozycji z reguły LLD

Pobierz wszystkie prototypy pozycji dla określonego identyfikatora reguły LLD.

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23077",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10079",
            "name": "Incoming network traffic on en0",
            "key_": "net.if.in[en0]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "bps",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        },
        {
            "itemid": "10010",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10001",
            "name": "Processor load (1 min average per core)",
            "key_": "system.cpu.load[percpu,avg1]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Znajdowanie zależnej pozycji

Znajdź jedną zależną pozycję dla określonego ID pozycji.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "filter": {
            "type": 18,
            "master_itemid": "25545"
        },
        "limit": "1"
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "25547",
            "type": "18",
            "snmp_oid": "",
            "hostid": "10116",
            "name": "Seconds",
            "key_": "apache.status.uptime.seconds",
            "delay": "0",
            "history": "90d",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "0",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "25545",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Znajdowanie prototypu pozycji HTTP agent

Znajdź prototyp pozycji HTTP agent z metodą żądania HEAD dla określonego ID hosta.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "hostids": "10254",
        "filter": {
            "type": 19,
            "request_method": 3
        }
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "28257",
            "type": "19",
            "snmp_oid": "",
            "hostid": "10254",
            "name": "discovered",
            "key_": "item[{#INAME}]",
            "delay": "{#IUPDATE}",
            "history": "90d",
            "trends": "30d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "2",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "{#IURL}",
            "query_fields": [],
            "posts": "",
            "status_codes": "",
            "follow_redirects": "0",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "3",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Zobacz także

Źródło

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