9 Graph (classic)

Opis

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

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

Parametry

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

Parameter type name value
Refresh interval 0 rf_rate 0 - Brak 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 0 - (domyślnie) Graph;
1 - Simple graph.
Graph 6 graphid.0 ID Graph.

Zachowanie parametru:
- wymagany jeśli Source jest ustawione na "Graph"
Graph (Widget) 1 graphid._reference Zamiast ID Graph:
ABCDE._graphid - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla wykresów.

Zachowanie parametru:
- wymagany jeśli Source jest ustawione na "Simple graph" i Graph nie jest ustawione
Item 4 itemid.0 ID pozycja.

Zachowanie parametru:
- wymagany jeśli Source jest ustawione na "Simple graph" i Item (Widget) nie jest ustawione
Item (Widget) 1 itemid._reference Zamiast ID pozycja:
ABCDE._itemid - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla pozycji.

Zachowanie parametru:
- wymagany jeśli Source jest ustawione na "Simple graph" i Item nie jest ustawione
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 względnej (now, now/d, now/w-1w itp.).

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

Zachowanie parametru:
- obsługiwany jeśli Time period nie jest ustawione
- wymagany jeśli time_period.from jest ustawione
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.
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 pulpitu, 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 Wykres (klasyczny). Aby uzyskać więcej informacji na temat konfigurowania pulpitu nawigacyjnego, zobacz dashboard.create.

Konfigurowanie widżetu Graph (classic)

Skonfiguruj widżet Graph (classic), który wyświetla prosty wykres dla pozycji „42269”.

Żądanie:

{
    "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
}

Odpowiedź:

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

Zobacz także