10 Graph prototype

Opis

Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają skonfigurowanie widgetu Graph prototype w metodach dashboard.create i dashboard.update.

Właściwości fields widgetu nie są walidowane podczas tworzenia ani aktualizacji dashboardu. Pozwala to użytkownikom modyfikować wbudowane widgety i tworzyć niestandardowe widgety, ale jednocześnie wprowadza ryzyko nieprawidłowego tworzenia lub aktualizowania widgetów. Aby zapewnić pomyślne utworzenie lub zaktualizowanie widgetu Graph prototype, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.

Parametry

Następujące parametry są obsługiwane dla widżetu Graph prototype.

Parameter type name value
Refresh interval 0 rf_rate 0 - Bez odświeżania;
10 - 10 sekund;
30 - 30 sekund;
60 - (domyślnie) 1 minuta;
120 - 2 minuty;
600 - 10 minut;
900 - 15 minut.
Source 0 source_type 2 - (domyślnie) Graph prototype;
3 - Simple graph prototype.
Graph prototype 7 graphid.0 ID Graph prototype.

Zachowanie parametru:
- wymagany jeśli Source jest ustawione na "Graph prototype"
Item prototype 5 itemid.0 ID Item prototype.

Zachowanie parametru:
- wymagany jeśli Source jest ustawione na "Simple graph prototype"
Time period 1 time_period._reference DASHBOARD._timeperiod - ustaw selektor Time period jako źródło danych;
ABCDE._timeperiod - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych.

Domyślnie: DASHBOARD._timeperiod

Alternatywnie można ustawić okres czasu tylko w parametrach From i To.
From 1 time_period.from Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub relatywnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- obsługiwany jeśli Time period nie jest ustawiony
- wymagany jeśli time_period.to jest ustawiony
To 1 time_period.to Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub relatywnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- obsługiwany jeśli Time period nie jest ustawiony
- wymagany jeśli time_period.from jest ustawiony
Show legend 0 show_legend 0 - Wyłączone;
1 - (domyślnie) Włączone.
Override host 1 override_hostid._reference ABCDE._hostid - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla hostów;
DASHBOARD._hostid - ustaw selektor Host na pulpicie jako źródło danych dla hostów.

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na szablonowym pulpicie.
Columns 0 columns Możliwe wartości mieszczą się w zakresie od 1 do 24.

Domyślnie: 2.
Rows 0 rows Możliwe wartości mieszczą się w zakresie od 1 do 16.

Domyślnie: 1.
Reference 1 reference Dowolna wartość tekstowa składająca się z 5 znaków (np. ABCDE lub JBPNL). Wartość ta musi być unikalna w obrębie dashboardu, do którego należy widżet.

Zachowanie parametru:
- wymagany

Przykłady

Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu Prototyp wykresu. Więcej informacji na temat konfiguracji pulpitu można znaleźć w dashboard.create.

Konfigurowanie widżetu Graph prototype

Skonfiguruj widżet Graph prototype, który wyświetla siatkę 3 wykresów (3 kolumny, 1 wiersz) utworzonych z prototypu pozycji (ID: "42316") przez wykrywanie niskopoziomowe.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graphprototype",
                        "name": "Graph prototype",
                        "x": 0,
                        "y": 0,
                        "width": 48,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "source_type",
                                "value": 3
                            },
                            {
                                "type": 5,
                                "name": "itemid.0",
                                "value": 42316
                            },
                            {
                                "type": 0,
                                "name": "columns",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "OPQWX"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Odpowiedź:

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

Zobacz także