Zabbix Documentation 4.4

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

ru:manual:api:reference:dashboard:get

dashboard.get

Описание

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

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

Параметры

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

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

Параметр Тип Описание
dashboardids строка/массив Возврат панелей только с заданными ID.
selectWidgets запрос Возврат свойства widgets c виджетами панели, которые используются на панели.
selectUsers запрос Возврат свойства users с пользователями, которые имеют общий доступ к панели.
selectUserGroups запрос Возврат свойства userGroups с группами пользователей, которые имеют общий доступ к панели.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

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

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

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

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

Пример

Получение панели по ID

Получение всех данных о панелях “1” и “2”.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.get",
    "params": {
        "output": "extend",
        "selectWidgets": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "dashboardids": [
            "1",
            "2"
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "dashboardid": "1",
            "name": "Dashboard",
            "userid": "1",
            "private": "0",
            "users": [],
            "userGroups": [],
            "widgets": [
                {
                    "widgetid": "9",
                    "type": "systeminfo",
                    "name": "",
                    "x": "12",
                    "y": "8",
                    "width": "12",
                    "height": "5",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "8",
                    "type": "problemsbysv",
                    "name": "",
                    "x": "12",
                    "y": "4",
                    "width": "12",
                    "height": "4",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "7",
                    "type": "problemhosts",
                    "name": "",
                    "x": "12",
                    "y": "0",
                    "width": "12",
                    "height": "4",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "6",
                    "type": "discovery",
                    "name": "",
                    "x": "6",
                    "y": "9",
                    "width": "6",
                    "height": "4",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "5",
                    "type": "web",
                    "name": "",
                    "x": "0",
                    "y": "9",
                    "width": "6",
                    "height": "4",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "4",
                    "type": "problems",
                    "name": "",
                    "x": "0",
                    "y": "3",
                    "width": "12",
                    "height": "6",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "3",
                    "type": "favmaps",
                    "name": "",
                    "x": "8",
                    "y": "0",
                    "width": "4",
                    "height": "3",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "2",
                    "type": "favscreens",
                    "name": "",
                    "x": "4",
                    "y": "0",
                    "width": "4",
                    "height": "3",
                    "view_mode": 0,
                    "fields": []
                },
                {
                    "widgetid": "1",
                    "type": "favgraphs",
                    "name": "",
                    "x": "0",
                    "y": "0",
                    "width": "4",
                    "height": "3",
                    "view_mode": 0,
                    "fields": []
                }
            ]
        },
        {
            "dashboardid": "2",
            "name": "My dashboard",
            "userid": "1",
            "private": "1",
            "users": [
                {
                    "userid": "4",
                    "permission": "3"
                }
            ],
            "userGroups": [
                {
                    "usrgrpid": "7",
                    "permission": "2"
                }
            ],
            "widgets": [
                {
                    "widgetid": "10",
                    "type": "problems",
                    "name": "",
                    "x": "0",
                    "y": "0",
                    "width": "12",
                    "height": "5",
                    "view_mode": 0,
                    "fields": [
                        {
                            "type": "2",
                            "name": "groupids",
                            "value": "4"
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}

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

Исходный код

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