9. График (классический)

Описание

Эти параметры и возможные значения свойств для соответствующих объектов полей виджета позволяют настраивать виджет Graph (classic) в методах dashboard.create и dashboard.update.

Свойства fields виджета не проверяются при создании или обновлении панели мониторинга. Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов. Чтобы обеспечить успешное создание или обновление виджета Graph (classic), ознакомьтесь с поведением параметров, описанным в таблицах ниже.

Параметры

Для виджета Graph (classic) поддерживаются следующие параметры.

Параметр type name value
Интервал обновления 0 rf_rate 0 - Без обновления;
10 - 10 секунд;
30 - 30 секунд;
60 - (по умолчанию) 1 минута;
120 - 2 минуты;
600 - 10 минут;
900 - 15 минут.
Источник 0 source_type 0 - (по умолчанию) График;
1 - Простой график.
График 6 graphid.0 ID графика.

Поведение параметра:
- обязателен, если для Источника установлено значение "График"
График (виджет) 1 graphid._reference Вместо ID графика:
ABCDE._graphid — использовать совместимый виджет (с параметром Reference, установленным в значение "ABCDE") в качестве источника данных для графиков.

Поведение параметра:
- обязателен, если для Источника установлено значение "Simple graph" и График не задан
Элемент данных 4 itemid.0 ID элемента данных.

Поведение параметра:
- обязателен, если для Источника установлено значение "Simple graph" и Элемент данных (виджет) не задан
Элемент данных (виджет) 1 itemid._reference Вместо ID элемента данных:
ABCDE._itemid — использовать совместимый виджет (с параметром Reference, установленным в значение "ABCDE") в качестве источника данных для элементов данных.

Поведение параметра:
- обязателен, если для Источника установлено значение "Simple graph" и Элемент данных не задан
Период времени 1 time_period._reference DASHBOARD._timeperiod — использовать селектор периода времени панели мониторинга в качестве источника данных;
ABCDE._timeperiod — использовать совместимый виджет (с параметром Reference, установленным в значение "ABCDE") в качестве источника данных.

По умолчанию: DASHBOARD._timeperiod

В качестве альтернативы можно задать период времени только в параметрах От и До.
От 1 time_period.from Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или в относительном формате времени (now, now/d, now/w-1w и т. д.).

Поведение параметра:
- поддерживается, если Период времени не задан
- обязателен, если задан time_period.to
До 1 time_period.to Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или в относительном формате времени (now, now/d, now/w-1w и т. д.).

Поведение параметра:
- поддерживается, если Период времени не задан
- обязателен, если задан time_period.from
Показывать легенду 0 show_legend 0 - Отключено;
1 - (по умолчанию) Включено.
Переопределить узел сети 1 override_hostid._reference ABCDE._hostid — использовать совместимый виджет (с параметром Reference, установленным в значение "ABCDE") в качестве источника данных для узлов сети;
DASHBOARD._hostid — использовать селектор узла сети панели мониторинга в качестве источника данных для узлов сети.

Этот параметр не поддерживается при настройке виджета на панели мониторинга шаблона.
Reference 1 reference Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели мониторинга, к которой принадлежит виджет.

Поведение параметра:
- обязателен

Примеры

Следующие примеры предназначены только для описания настройки объектов полей виджета панели мониторинга для виджета Graph (classic). Для получения дополнительной информации о настройке панели мониторинга смотрите dashboard.create.

Настройка виджета Graph (classic)

Настройте виджет Graph (classic), отображающий простой график для элемента данных "42269".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graph",
                        "name": "Graph (classic)",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "source_type",
                                "value": 1
                            },
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 42269
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "RSTUV"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

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