Documentation
Table of Contents
itemprototype.get
Leírás
integer/array itemprototype.get(objektumparaméterek)
A módszer lehetővé teszi a cikk prototípusainak visszakeresését a megadottak szerint paramétereket.
Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.
Paraméterek
(object) A kívánt kimenetet meghatározó paraméterek.
A módszer a következő paramétereket támogatja.
| Paraméter | Típus | Leírás |
|---|---|---|
| discoveryids | string/array | Csak az adott LLD-szabályokhoz tartozó elem prototípusait adja vissza. |
| graphids | string/array | Csak az adott gráf prototípusokban használt elemprototípusokat adja vissza. |
| hostids | string/array | Csak az adott gazdagéphez tartozó elem prototípusait adja vissza. |
| inherited | boolean | Ha true-ra van állítva, csak a sablonból örökölt elemek prototípusait adja vissza. |
| itemids | string/array | Csak a megadott azonosítókkal rendelkező elem prototípusokat adja vissza. |
| monitored | boolean | Ha true-ra van állítva, csak a felügyelt gazdagépekhez tartozó engedélyezett elemek prototípusait adja vissza. |
| templated | boolean | Ha true-ra van állítva, csak a sablonokhoz tartozó elemek prototípusait adja vissza. |
| templateids | string/array | Csak az adott sablonokhoz tartozó elemprototípusokat ad vissza. |
| triggerids | string/array | Csak az adott trigger prototípusokban használt elemprototípusokat adja vissza. |
| selectDiscoveryRule | query | Vissza vissza a discoveryRule tulajdonságot azzal az alacsony szintű felfedezési szabállyal, amelyhez az elem prototípusa tartozik. |
| selectGraphs | query | Vitasson vissza egy manual/api/reference/graphprototype/object#graph_prototype tulajdonságot olyan gráf prototípusokkal, amelyekben az elem prototípusát használják.< br> Támogatja a count. |
| selectHosts | query | Vitasson vissza egy hosts tulajdonságot olyan gazdagépekkel, amelyekhez az elem prototípusa tartozik. |
| selectTags | query | Vissza vissza az elem prototípus címkéit a tags tulajdonságban. |
| selectTriggers | query | Vitasson vissza egy triggers tulajdonságot olyan trigger prototípusokkal, amelyekben az elem prototípusa használatos. Támogatja a count. |
| selectPreprocessing | query | Vitasson vissza egy preprocessing tulajdonságot elem-előfeldolgozási beállításokkal. A következő tulajdonságokkal rendelkezik: type - (karakterlánc) Az előfeldolgozási beállítás típusa:1 - Egyéni szorzó; 2 - Jobb oldali vágás; 3 - Bal vágás; 4 - Levágás; 5 - Reguláris kifejezés illesztése;< br>6 – Logikai értéktől tizedesjegyig; 7 – Oktálistól decimálisig; 8 – Hexadecimálistól decimálisig; 9 – Egyszerű változtatás; 10 – Változás másodpercenként; 11 – XML XPath ; 12 - JSONPath; 13 - Tartományban; 14 - Reguláris kifejezésnek felel meg; 15 - Nem egyezik a reguláris kifejezéssel; 16 - Hiba keresése a JSON-ban; 17 - Hiba ellenőrzése XML-ben; 18 - Hiba ellenőrzése reguláris kifejezéssel; 19 - Változatlan elvetés; 20 - Változatlan elvetés szívveréssel; 21 - JavaScript; 22 - Prometheus minta; 23 - Prometheus JSON-ra; 24 - CSV-ből JSON-ra; 25 - Csere; 26 - Nem támogatott érték ellenőrzése; 27- XML-ből JSON. "params" - "(str ing) Az előfeldolgozási opció által használt további paraméterek. Több paraméter LF (\\n)karakterrel van elválasztva.error_handler-(karakterlánc)Az előfeldolgozási lépés sikertelensége esetén használt művelettípus:error_handler_params-(karakterlánc)Hibakezelő paraméterei.| |selectValueMap|query|Vissza vissza a [valuemap](/manual/api/reference/valuemap/object) tulajdonságot az elem prototípus értéktérképével.| |filter|object|Csak azokat az eredményeket adja vissza, amelyek pontosan egyeznek az adott szűrővel.host- annak a gazdagépnek a technikai neve, amelyhez az elem prototípusa tartozik.| |limitSelects|integer|Korlátozza az alkijelölések által visszaadott rekordok számát.itemid,name,key_,delay,typeésstatus.| |countOutput|boolean|Ezek a paraméterek, amelyek mindenget` metódusnál közösek, a referenciakommentár részben találhatók. |
| szerkeszthető | logikai | |
| excludeSearch | logikai | |
| korlát | egész szám | |
| kimenet | lekérdezés | |
| preservekeys | boolean | |
| kereső | objektum | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | karakterlánc/tömb | |
| startSearch | boolean |
Visszatérési értékek
(integer/array) A következőket adja vissza:
- objektumok tömbje;
- a letöltött objektumok száma, ha a
countOutputparaméter rendelkezik használtak.
Példák
Retrieving item prototypes from an LLD rule
Retrieve all item prototypes for specific LLD rule ID.
Request:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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": "",
"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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 1
}Finding dependent item
Find one Dependent item for item with ID "25545".
Request:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": "18",
"master_itemid": "25545"
},
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3s",
"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": "",
"parameters": []
}
],
"id": 1
}Find HTTP agent item prototype
Find HTTP agent item prototype with request method HEAD for specific host ID.
Request:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Response:
{
"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": "",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "2",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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": "",
"parameters": []
}
],
"id": 17
}Lásd még
Forrás
CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.