Documentation
Table of Contents
itemprototype.get
Опис
integer/array itemprototype.get(object parameters)
Метода омогућава преузимање прототипова ставке према датим параметрима.
Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.
Параметрi
(object) Параметри који дефинишу жељени излаз.
Метод подржава следеће параметре.
| Parameter | Type | Description |
|---|---|---|
| discoveryids | ID/array | Враћа само прототипове ставки који припадају наведеним LLD правилима. |
| graphids | ID/array | Враћа само прототипове ставки који се користе у датим прототиповима графова. |
| hostids | ID/array | Враћа само прототипове ставки које припадају датим домаћинима. |
| inherited | boolean | Ако је постављено на true враћа само прототипове ставке наслеђене из шаблона. |
| itemids | ID/array | Враћа само прототипове ставки са датим ИД-ијевима. |
| monitored | boolean | Ако је постављено на true враћа само омогућене прототипове ставки које припадају надгледаним шаблонима. |
| templated | boolean | Ако је постављено на true враћа само прототипове ставки који припадају шаблонима. |
| templateids | ID/array | Враћа само прототипове ставки који припадају датим шаблонима. |
| triggerids | ID/array | Враћа само прототипове ставке који се користе у датим прототиповима окидача. |
| selectDiscoveryRule | query | Враћа својство discoveryRule са правилом откривања ниског нивоа коме припада прототип ставке. |
| selectGraphs | query | Враћа својство graphs са прототиповима графикона у којима се користи прототип ставке.Подржава count. |
| selectHosts | query | Враћа својство hosts са низом домаћина којима припада прототип ставке. |
| selectTags | query | Враћа ознаке прототипа ставке у својству tags. |
| selectTriggers | query | Враћа својство triggers са прототиповима окидача у којима се користи прототип ставке.Подржава count. |
| selectPreprocessing | query | Враћа својство preprocessing са опцијама за предобраду прототипа ставке. |
| selectValueMap | query | Враћа својство valuemap са мапом вредности прототипа ставке. |
| filter | object | Враћа само оне резултате који се тачно подударају са датим филтером. Прихвата објекат, где су кључеви имена својстава, а вредности су или једна вредност или низ вредности за подударање. Не подржава својства text тип података.Подржава додатне својства: host - техничко име домаћина коме припада прототип ставке. |
| limitSelects | intege | Ограничава број записа које враћају подизбори. Примењује се на следеће подизборе: selectGraphs - резултати ће бити сортирани према name;selectTriggers - резултати биће сортирани према description. |
| sortfield | string/array | Сортирај резултат према датим својствима. Могуће вредности: itemid, name, key_, delay, type, status. |
| countOutput | boolean | Ови параметри који су заједнички за све методе get су детаљно описани у референтном коментару. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Повратне вредности
(integer/array) Враћа било:
- низ објеката;
- број преузетих објеката, ако је параметар
countOutputкоришћен.
Примери
Преузимање прототипова ставки из LLD правила
Преузми све прототипове ставки за одређени ID LLD правила.
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"id": 1
}Одговор:
{
"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": "",
"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": "",
"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
}Проналажење зависне ставке
Пронађите једну зависну ставку за специфични ID ставке.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": 18,
"master_itemid": "25545"
},
"limit": "1"
},
"id": 1
}Одговор:
{
"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": "",
"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
}Пронађите прототип ставке HTTP агента
Пронађите прототип ставке HTTP агента са методом захтева HEAD за одређене ID ставке.
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": 19,
"request_method": 3
}
},
"id": 1
}Одговор:
{
"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": "",
"flags": "2",
"interfaceid": "2",
"description": "",
"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": "",
"parameters": []
}
],
"id": 1
}Погледајте такође
Извор
CItemPrototype::get() у ui/include/classes/api/services/CItemPrototype.php.