Zabbix Documentation 3.0

2.23.04.0 (current)In development:4.2 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

ru:manual:api:reference:map:get

map.get

Описание

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

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

Параметры

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

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

ПараметрТипОписание
sysmapids строка/массив Возврат карт сетей только с заданными ID.
userids строка/массив Возврат только тех карт сетей, которые принадлежат заданным ID пользователей.
expandUrls флаг Добавление глобальных URL карты в соответствующие элементы карты и раскрытие макросов во всех URL элементах карты сети.
selectIconMap запрос Возврат соответствия иконок, которое используется картой сети, в свойстве iconmap.
selectLinks запрос Возврат связей между элементами карты сети в свойстве links.
selectSelements запрос Возврат элементов карты с карты сети в свойстве selements.
selectUrls запрос Возврат URL'ов карты в свойстве urls.
selectUsers запрос Возврат пользователей, которым предоставлен общий доступ к карте сети, в свойстве users.
selectUserGroups запрос Возврат групп пользователей, которым предоставлен общий доступ к карте сети, в свойстве userGroups.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

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

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

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

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

Примеры

Получение карты сети

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "map.get",
    "params": {
        "output": "extend",
        "selectSelements": "extend",
        "selectLinks": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "sysmapids": "3"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "selements": [
                {
                    "selementid": "10",
                    "sysmapid": "3",
                    "elementid": "0",
                    "elementtype": "4",
                    "iconid_off": "1",
                    "iconid_on": "0",
                    "label": "Zabbix server",
                    "label_location": "3",
                    "x": "11",
                    "y": "141",
                    "iconid_disabled": "0",
                    "iconid_maintenance": "0",
                    "elementsubtype": "0",
                    "areatype": "0",
                    "width": "200",
                    "height": "200",
                    "viewtype": "0",
                    "use_iconmap": "1",
                    "application": "",
                    "urls": []
                },
                {
                    "selementid": "11",
                    "sysmapid": "3",
                    "elementid": "0",
                    "elementtype": "4",
                    "iconid_off": "1",
                    "iconid_on": "0",
                    "label": "Web server",
                    "label_location": "3",
                    "x": "211",
                    "y": "191",
                    "iconid_disabled": "0",
                    "iconid_maintenance": "0",
                    "elementsubtype": "0",
                    "areatype": "0",
                    "width": "200",
                    "height": "200",
                    "viewtype": "0",
                    "use_iconmap": "1",
                    "application": "",
                    "urls": []
                }
            ],
            "links": [
                {
                    "linkid": "23",
                    "sysmapid": "3",
                    "selementid1": "10",
                    "selementid2": "11",
                    "drawtype": "0",
                    "color": "00CC00",
                    "label": "",
                    "linktriggers": []
                }
            ],
            "users": [
                {
                    "sysmapuserid": "1",
                    "userid": "2",
                    "permission": "2"
                }
            ],
            "userGroups": [
                {
                    "sysmapusrgrpid": "1",
                    "usrgrpid": "7",
                    "permission": "2"
                }
            ],
            "sysmapid": "3",
            "name": "Local nerwork",
            "width": "400",
            "height": "400",
            "backgroundid": "0",
            "label_type": "2",
            "label_location": "3",
            "highlight": "1",
            "expandproblem": "1",
            "markelements": "0",
            "show_unack": "0",
            "grid_size": "50",
            "grid_show": "1",
            "grid_align": "1",
            "label_format": "0",
            "label_type_host": "2",
            "label_type_hostgroup": "2",
            "label_type_trigger": "2",
            "label_type_map": "2",
            "label_type_image": "2",
            "label_string_host": "",
            "label_string_hostgroup": "",
            "label_string_trigger": "",
            "label_string_map": "",
            "label_string_image": "",
            "iconmapid": "0",
            "expand_macros": "0",
            "severity_min": "0",
            "userid": "1",
            "private": "1"
        }
    ],
    "id": 1
}

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

Исходный код

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