9 Gráfico (clássico)

Descrição

Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget do dashboard permitem configurar o widget Gráfico (clássico) 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 Gráfico (clássico), consulte o comportamento dos parâmetros descrito nas tabelas abaixo.

Parâmetros

Os seguintes parâmetros são suportados para o widget Gráfico (clássico).

Parâmetro tipo nome valor
Intervalo de atualização 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.
Fonte 0 source_type 0 - (padrão) Gráfico;
1 - Gráfico simples.
Gráfico 6 graphid.0 ID do Gráfico.

Comportamento do parâmetro:
- obrigatório se Fonte estiver definida como "Gráfico"
Gráfico (Widget) 1 graphid._reference Em vez do ID do Gráfico:
ABCDE._graphid - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como a fonte de dados para gráficos.

Comportamento do parâmetro:
- obrigatório se Fonte estiver definida como "Gráfico simples" e Gráfico não estiver definido
Item 4 itemid.0 ID do Item.

Comportamento do parâmetro:
- obrigatório se Fonte estiver definida como "Gráfico simples" e Item (Widget) não estiver definido
Item (Widget) 1 itemid._reference Em vez do ID do Item:
ABCDE._itemid - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como a fonte de dados para items.

Comportamento do parâmetro:
- obrigatório se Fonte estiver definida como "Gráfico simples" e Item não estiver definido
Período de tempo 1 time_period._reference DASHBOARD._timeperiod - defina o seletor de período de tempo do dashboard como a fonte de dados;
ABCDE._timeperiod - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como a fonte de dados.

Padrão: DASHBOARD._timeperiod

Alternativamente, você pode definir o período de tempo apenas nos parâmetros De e Até.
De 1 time_period.from String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou na sintaxe de tempo relativo (now, now/d, now/w-1w, etc.).

Comportamento do parâmetro:
- suportado se Período de tempo não estiver definido
- obrigatório se time_period.to estiver definido
Até 1 time_period.to String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou na sintaxe de tempo relativo (now, now/d, now/w-1w, etc.).

Comportamento do parâmetro:
- suportado se Período de tempo não estiver definido
- obrigatório se time_period.from estiver definido
Exibir legenda 0 show_legend 0 - Desabilitado;
1 - (padrão) Habilitado.
Sobrescrever host 1 override_hostid._reference ABCDE._hostid - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como a fonte de dados para hosts;
DASHBOARD._hostid - defina o seletor de host do dashboard como a fonte de dados para hosts.

Este parâmetro não é suportado ao configurar o widget em um dashboard de template.
Referência 1 reference Qualquer valor de string composto por 5 caracteres (por exemplo, ABCDE ou JBPNL). Este valor deve ser exclusivo dentro do dashboard ao qual o widget pertence.

Comportamento do parâmetro:
- obrigatório

Exemplos

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

Configurando um widget Graph (classic)

Configure um widget Graph (classic) que exibe um gráfico simples para o item "42269".

Requisição:

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

Resposta:

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

Veja também