Zabbix Documentation 3.2

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


Sidebar

ru:manual:api:reference:item:get

item.get

Описание

целое число/массив item.get(объект параметры)

Этот метод позволяет получать элементы данных в соответствии с заданными параметрами.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр Тип Описание
itemids строка/массив Возврат элементов данных только с заданными ID.
groupids строка/массив Возврат только тех элементов данных, которые принадлежат узлам сети с заданных групп узлов сети.
templateids строка/массив Возврат только тех элементов данных, которые принадлежат заданным шаблонам.
hostids строка/массив Возврат только тех элементов данных, которые принадлежат заданным узлам сети.
proxyids строка/массив Возврат только тех элементов данных, которые наблюдаются заданными прокси.
interfaceids строка/массив Возврат только тех элементов данных, которые используют заданные интерфейсы узлов сети.
graphids строка/массив Возврат только тех элементов данных, которые используются в заданных графиках.
triggerids строка/массив Возврат только тех элементов данных, которые используются в заданных триггерах.
applicationids строка/массив Возврат только тех элементов данных, которые входят в заданные группы элементов данных.
webitems флаг Включение в результат веб элементов данных.
inherited логический Если задано значение true, возвращать только те элементы данных, которые унаследованы из шаблона.
templated логический Если задано значение true, возвращать только те элементы данных, которые принадлежат шаблонам.
monitored логический Если задано значение true, возвращать только активированные элементы данных, которые принадлежат узлам сети под наблюдением.
group строка Возврат только тех элементов данных, которые принадлежат группе с заданным именем.
host строка Возврат только тех элементов данных, которые принадлежат узлу сети с заданным именем.
application строка Возврат только тех элементов данных, которые входят в группу элементов данных с заданным именем.
with_triggers логический Если задано значение true, возвращать только те элементы данных, которые используются в триггерах.
selectHosts запрос Возврат узла сети, которому принадлежит элемент данных, в виде массива в свойстве hosts.
selectInterfaces запрос Возврат интерфейса узла сети, который используется элементом данных, в виде массива в свойстве interfaces.
selectTriggers запрос Возврат триггеров, которые используют элемент данных, в свойстве triggers.

Поддерживается count.
selectGraphs запрос Возврат графиков, которые содержат элемент данных, в свойстве graphs.

Поддерживается count.
selectApplications запрос Возврат групп элементов данных, которым принадлежит элемент данных, в свойстве applications.
selectDiscoveryRule запрос Возврат LLD правила, которое создало элемент данных, в свойстве discoveryRule.
selectItemDiscovery запрос Возврат объекта обнаружения элемента данных в свойстве itemDiscovery.

Объект обнаружения элемента данных связывает элемент данных с прототипом элементов данных и имеет следующие свойства:
itemdiscoveryid - (строка) ID обнаружения элемента данных;
itemid - (строка) ID обнаруженного элемента данных;
parent_itemid - (строка) ID прототипа элемента данных с которого был создан элемент данных;
key_ - (строка) ключ прототипа элемента данных;
lastcheck - (штамп времени) время, когда элемент данных был в последний раз обнаружен;
ts_delete - (штамп времени) время, когда более необнаруживаемый элемент данных будет удален.
filter объект Возврат только тех результатов, которые в точности соответствуют заданному фильтру.

Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений.

Поддерживает дополнительные фильтры:
host - техническое имя узла сети, которому принадлежит элемент данных.
limitSelects целое число Ограничение количества записей, возвращаемых подзапросами.

Применимо только к следующим подзапросам:
selectGraphs - результаты сортируются по name;
selectTriggers - результаты сортируются по description.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: itemid, name, key_, delay, history, trends, type и status.
countOutput флагЭти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch флаг
limit целое число
output запрос
preservekeys флаг
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch флаг

Возвращаемые значения

(целое число/массив) Возвращает либо:

  • массив объектов;
  • количество найденных объектов, если используется параметр countOutput.

Примеры

Поиск элементов данных по ключу

Получение всех элементов данных с узлов сети с ID “10084”, которые имеют в ключе слово “system” и сортировка результата по имени.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "item.get",
    "params": {
        "output": "extend",
        "hostids": "10084",
        "search": {
            "key_": "system"
        },
        "sortfield": "name"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23298",
            "type": "0",
            "snmp_community": "",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Context switches per second",
            "key_": "system.cpu.switches",
            "delay": "60",
            "history": "7",
            "trends": "365",
            "lastvalue": "2552",
            "lastclock": "1351090998",
            "prevvalue": "2641",
            "state": "0",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "sps",
            "multiplier": "0",
            "delta": "1",
            "snmpv3_securityname": "",
            "snmpv3_securitylevel": "0",
            "snmpv3_authpassphrase": "",
            "snmpv3_privpassphrase": "",
            "snmpv3_authprotocol": "0",
            "snmpv3_privprotocol": "0",
            "snmpv3_contextname": "",
            "formula": "1",
            "error": "",
            "lastlogsize": "0",
            "logtimefmt": "",
            "templateid": "22680",
            "valuemapid": "0",
            "delay_flex": "",
            "params": "",
            "ipmi_sensor": "",
            "data_type": "0",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "mtime": "0",
            "lastns": "564054253",
            "flags": "0",
            "interfaceid": "1",
            "port": "",
            "description": "",
            "inventory_link": "0",
            "lifetime": "0",
            "evaltype": "0"
        },
        {
            "itemid": "23299",
            "type": "0",
            "snmp_community": "",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "CPU $2 time",
            "key_": "system.cpu.util[,idle]",
            "delay": "60",
            "history": "7",
            "trends": "365",
            "lastvalue": "86.031879",
            "lastclock": "1351090999",
            "prevvalue": "85.306944",
            "state": "0",
            "status": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "units": "%",
            "multiplier": "0",
            "delta": "0",
            "snmpv3_securityname": "",
            "snmpv3_securitylevel": "0",
            "snmpv3_authpassphrase": "",
            "snmpv3_privpassphrase": "",
            "snmpv3_authprotocol": "0",
            "snmpv3_privprotocol": "0",
            "snmpv3_contextname": "",
            "formula": "1",
            "error": "",
            "lastlogsize": "0",
            "logtimefmt": "",
            "templateid": "17354",
            "valuemapid": "0",
            "delay_flex": "",
            "params": "",
            "ipmi_sensor": "",
            "data_type": "0",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "mtime": "0",
            "lastns": "564256864",
            "flags": "0",
            "interfaceid": "1",
            "port": "",
            "description": "The time the CPU has spent doing nothing.",
            "inventory_link": "0",
            "lifetime": "0",
            "evaltype": "0"
        },
        {
            "itemid": "23300",
            "type": "0",
            "snmp_community": "",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "CPU $2 time",
            "key_": "system.cpu.util[,interrupt]",
            "delay": "60",
            "history": "7",
            "trends": "365",
            "lastvalue": "0.008389",
            "lastclock": "1351091000",
            "prevvalue": "0.000000",
            "state": "0",
            "status": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "units": "%",
            "multiplier": "0",
            "delta": "0",
            "snmpv3_securityname": "",
            "snmpv3_securitylevel": "0",
            "snmpv3_authpassphrase": "",
            "snmpv3_privpassphrase": "",
            "snmpv3_authprotocol": "0",
            "snmpv3_privprotocol": "0",
            "snmpv3_contextname": "",
            "formula": "1",
            "error": "",
            "lastlogsize": "0",
            "logtimefmt": "",
            "templateid": "22671",
            "valuemapid": "0",
            "delay_flex": "",
            "params": "",
            "ipmi_sensor": "",
            "data_type": "0",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "mtime": "0",
            "lastns": "564661387",
            "flags": "0",
            "interfaceid": "1",
            "port": "",
            "description": "The amount of time the CPU has been servicing hardware interrupts.",
            "inventory_link": "0",
            "lifetime": "0",
            "evaltype": "0"
        }
    ],
    "id": 1
}

Смотрите также

Исходный код

CItem::get() в frontends/php/include/classes/api/services/CItem.php.