Zabbix Documentation 3.4

iconmap.get

Описание

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

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

Параметры

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

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

Параметр	Тип	Описание
iconmapids	строка/массив	Возврат соответствий иконок только с заданными ID.
sysmapids	строка/массив	Возврат только тех соответствий иконок, которые используются заданными картами сети.

selectMappings	запрос	Возврат используемых соответствий иконок в свойстве `mappings`.

sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `iconmapid` и `name`.
countOutput	логический	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	логический
filter	объект
limit	целое число
output	запрос
preservekeys	логический
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	логический

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

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

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

Примеры

Получение соответствия иконок

Получение всех данных соответствия иконок “3”.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "iconmap.get",
    "params": {
        "iconmapids": "3",
        "output": "extend",
        "selectMappings": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "mappings": [
                {
                    "iconmappingid": "3",
                    "iconmapid": "3",
                    "iconid": "6",
                    "inventory_link": "1",
                    "expression": "server",
                    "sortorder": "0"
                },
                {
                    "iconmappingid": "4",
                    "iconmapid": "3",
                    "iconid": "10",
                    "inventory_link": "1",
                    "expression": "switch",
                    "sortorder": "1"
                }
            ],
            "iconmapid": "3",
            "name": "Host type icons",
            "default_iconid": "2"
        }
    ],
    "id": 1
}

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

Карта иконок

Исходный код

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