15 Cartão de item

Descrição

Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget de dashboard permitem configurar o widget Item card nos métodos dashboard.create e dashboard.update.

As propriedades fields do widget não são validadas durante a criação ou atualização de um dashboard. Isso permite que os usuários modifiquem widgets internos e criem widgets personalizados, mas também introduz o risco de criar ou atualizar widgets incorretamente. Para garantir a criação ou atualização bem-sucedida do widget Item card, consulte o comportamento do parâmetro descrito nas tabelas abaixo.

Parâmetros

Os seguintes parâmetros são suportados para o widget Item card.

Parameter type name value
Refresh interval 0 rf_rate 0 - Sem atualização;
10 - 10 segundos;
30 - 30 segundos;
60 - (padrão) 1 minuto;
120 - 2 minutos;
600 - 10 minutos;
900 - 15 minutos.
Item 4 itemid.0 ID do Item.

Comportamento do parâmetro:
- obrigatório se Item (Widget) não estiver definido
Item (Widget) 1 itemid._reference Em vez do ID do Item:
ABCDE._itemid - define um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados para o item.

Comportamento do parâmetro:
- obrigatório se Item não estiver definido
Show 0 sections.0 0 - Descrição;
1 - Texto de erro;
2 - Métricas;
3 - Dados mais recentes;
4 - Tipo de informação;
5 - Triggers;
6 - Interface do host;
7 - Tipo;
8 - Inventário do host;
9 - Tags.

Observação: O número no nome da propriedade faz referência à ordem da seção na lista de seções. Para configurar várias seções, crie um objeto de campo do widget do dashboard para cada seção com um número incrementado no nome da propriedade.
Override host 1 override_hostid._reference ABCDE._hostid - define um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados para hosts;
DASHBOARD._hostid - define o seletor de Host do dashboard como a fonte de dados para hosts.

Padrão: "" (vazio)

Este parâmetro não é suportado ao configurar o widget em um template dashboard.

Sparkline

Os seguintes parâmetros são suportados se Show estiver definido como "Latest data".

Parameter type name value
Width 0 sparkline.width Os valores possíveis variam de 0 a 10.

Padrão: 1.
Fill 0 sparkline.fill Os valores possíveis variam de 0 a 10.

Padrão: 3.
Color 1 sparkline.color Código de cor hexadecimal (por exemplo, FF0000).

Padrão: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - define o seletor Time period como a fonte de dados;
ABCDE._timeperiod - define um widget compatível (com seu parâmetro reference igual a ABCDE) como a fonte de dados.

Padrão: "" (vazio)

Como alternativa, você pode definir o período de tempo apenas nos parâmetros From e To.
From 1 sparkline.time_period.from String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).

Padrão: now-1h.

Comportamento do parâmetro:
- supported se Time period não estiver definido
- required se sparkline.time_period.to estiver definido
To 1 sparkline.time_period.to String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).

Padrão: now.

Comportamento do parâmetro:
- supported se Time period não estiver definido
- required se time_period.from estiver definido
History data 0 sparkline.history 0 - (padrão) Auto;
1 - History;
2 - Trends.

Exemplos

Os exemplos a seguir têm como objetivo descrever apenas a configuração dos objetos de campo do widget do painel para o widget Item card. Para obter mais informações sobre como configurar um painel, consulte dashboard.create.

Configurando um widget Item card

Configure um widget Item card que exibe estas seções: "Descrição", "Últimos dados", "Triggers" e "Tags".

Requisição:

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

Resposta:

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

Veja também