15 Karta pozycji

Opis

Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają konfigurację widgetu Item card 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 Item card, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.

Parametry

Następujące parametry są obsługiwane dla widżetu Item card.

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.
Item 4 itemid.0 ID pozycja.

Zachowanie parametru:
- wymagany, jeśli Item (Widget) nie jest ustawiony
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 Item nie jest ustawiony
Show 0 sections.0 0 - Opis;
1 - Tekst błędu;
2 - Metryki;
3 - Najnowsze dane;
4 - Typ informacji;
5 - Wyzwalacze;
6 - Interfejs hosta;
7 - Typ;
8 - Inwentarz hosta;
9 - Tagi.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności sekcji na liście sekcji. Aby skonfigurować wiele sekcji, utwórz obiekt pola widżetu dashboardu dla każdej sekcji, zwiększając numer w nazwie właściwości.
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 dashboardzie jako źródło danych dla hostów.

Domyślnie: "" (pusty)

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na szablon dashboardu.

Sparkline

Następujące parametry są obsługiwane, jeśli Show jest ustawione na "Latest data".

Parameter type name value
Width 0 sparkline.width Możliwe wartości mieszczą się w zakresie 0-10.

Domyślnie: 1.
Fill 0 sparkline.fill Możliwe wartości mieszczą się w zakresie 0-10.

Domyślnie: 3.
Color 1 sparkline.color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - ustaw selektor Time period jako źródło danych;
ABCDE._timeperiod - ustaw kompatybilny widget (z parametrem reference równym ABCDE) jako źródło danych.

Domyślnie: "" (puste)

Alternatywnie można ustawić okres czasu tylko w parametrach From i To.
From 1 sparkline.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 itp.).

Domyślnie: now-1h.

Zachowanie parametru:
- supported jeśli Time period nie jest ustawiony
- required jeśli sparkline.time_period.to jest ustawiony
To 1 sparkline.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 itp.).

Domyślnie: now.

Zachowanie parametru:
- supported jeśli Time period nie jest ustawiony
- required jeśli time_period.from jest ustawiony
History data 0 sparkline.history 0 - (domyślnie) Auto;
1 - Historia;
2 - Trendy.

Przykłady

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

Konfigurowanie widżetu Karta pozycji

Skonfiguruj widżet Karta pozycji, który wyświetla następujące sekcje: „Opis”, „Najnowsze dane”, „Wyzwalacze” i „Tagi”.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemcard",
                        "name": "Item card",
                        "x": 0,
                        "y": 0,
                        "width": 14,
                        "height": 7,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 42257
                            },
                            {
                                "type": 0,
                                "name": "sections.0",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "sections.1",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "sections.2",
                                "value": 5
                            },
                            {
                                "type": 0,
                                "name": "sections.3",
                                "value": 9
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Odpowiedź:

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

Zobacz także