Documentation
Table of Contents
itemprototype.get
Описание
целое число/массив itemprototype.get(объект параметры)
Этот метод позволяет получать прототипы элементов данных в соответствии с заданными параметрами.
Параметры
(объект) Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| discoveryids | строка/массив | Возврат только тех прототипов элементов данных, которые используются в заданных LLD правилах. |
| graphids | строка/массив | Возврат только тех прототипов элементов данных, которые используются в заданных прототипах графиков. |
| hostids | строка/массив | Возврат только тех прототипов элементов данных, которые принадлежат заданным узлам сети. |
| inherited | логический | Если задано значение true, возвращать только те прототипы элементов данных, которые унаследованы из шаблона. |
| itemids | строка/массив | Возврат прототипов элементов данных только с заданными ID. |
| monitored | логический | Если задано значение true, возвращать только активированные прототипы элементов данных, которые принадлежат узлам сети под наблюдением. |
| templated | логический | Если задано значение true, возвращать только те прототипы элементов данных, которые принадлежат шаблонам. |
| templateids | строка/массив | Возврат только тех прототипов элементов данных, которые принадлежат заданным шаблонам. |
| triggerids | строка/массив | Возврат только тех прототипов элементов данных, которые используются в заданных прототипах триггеров. |
| selectApplications | запрос | Возврат групп элементов данных, которым принадлежит прототип элементов данных, в свойстве applications. |
| selectDiscoveryRule | запрос | Возврат LLD правила, которому принадлежит прототип элементов данных, в свойстве discoveryRule. |
| selectGraphs | запрос | Возврат прототипов графиков, которые содержат прототип элементов данных, в свойстве graphs.Supports count. |
| selectHosts | запрос | Возврат узла сети, которому принадлежит прототип элементов данных, в виде массива в свойстве hosts. |
| selectTriggers | запрос | Возврат прототипов триггеров, которые используют прототип элементов данных, в свойстве triggers.Supports count. |
| filter | объект | Возврат только тех результатов, которые в точности соответствуют заданному фильтру. Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений. Поддерживает дополнительные фильтры: host - техническое имя узла сети, которому принадлежит прототип элементов данных. |
| limitSelects | целое число | Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: selectGraphs - результаты сортируются по name;selectTriggers - результаты сортируются по description. |
| sortfield | строка/массив | Сортировка результата в соответствии с заданными свойствами. Возможные значения: itemid, name, key_, delay, type и status. |
| countOutput | флаг | Эти параметры являются общими для всех методов get и они описаны в справочных комментариях. |
| editable | логический | |
| excludeSearch | флаг | |
| limit | целое число | |
| output | запрос | |
| preservekeys | флаг | |
| search | объект | |
| searchByAny | логический | |
| searchWildcardsEnabled | логический | |
| sortorder | строка/массив | |
| startSearch | флаг |
Возвращаемые значения
(целое число/массив) Возвращает либо:
- массив объектов;
- количество найденных объектов, если используется параметр
countOutput.
Примеры
Получение прототипов элементов данных с LLD правила
Получение всех прототипов элементов данных с LLD правила.
Запрос:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Ответ:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "27427",
"type": "0",
"snmp_community": "",
"snmp_oid": "",
"hostid": "10202",
"name": "Incoming network traffic on $1 23",
"key_": "2net.if.in[{#IFNAME}]",
"delay": "60",
"history": "7",
"trends": "365",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "bps",
"multiplier": "1",
"delta": "1",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"formula": "8",
"logtimefmt": "",
"templateid": "23881",
"valuemapid": "0",
"delay_flex": "",
"params": "",
"ipmi_sensor": "",
"data_type": "0",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"mtime": "0",
"filter": "",
"interfaceid": "119",
"port": "",
"description": "",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0"
},
{
"itemid": "27428",
"type": "0",
"snmp_community": "",
"snmp_oid": "",
"hostid": "10202",
"name": "Incoming network traffic on $1",
"key_": "net.if.in[{#IFNAME}]",
"delay": "60",
"history": "7",
"trends": "365",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "bps",
"multiplier": "1",
"delta": "1",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"formula": "8",
"logtimefmt": "",
"templateid": "22446",
"valuemapid": "0",
"delay_flex": "",
"params": "",
"ipmi_sensor": "",
"data_type": "0",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"mtime": "0",
"filter": "",
"interfaceid": "119",
"port": "",
"description": "",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0"
}
],
"id": 1
}Смотрите также
Исходный код
CItemPrototype::get() в frontends/php/include/classes/api/services/CItemPrototype.php.