10 Protótipo de gráfico

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 Protótipo de gráfico 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 Protótipo de gráfico, consulte o comportamento do parâmetro descrito nas tabelas abaixo.

Parâmetros

Os seguintes parâmetros são suportados para o widget Graph prototype.

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.
Source 0 source_type 2 - (padrão) Graph prototype;
3 - Simple graph prototype.
Graph prototype 7 graphid.0 ID do Graph prototype.

Comportamento do parâmetro:
- obrigatório se Source estiver definido como "Graph prototype"
Item prototype 5 itemid.0 ID do Item prototype.

Comportamento do parâmetro:
- obrigatório se Source estiver definido como "Simple graph prototype"
Time period 1 time_period._reference DASHBOARD._timeperiod - define o seletor Time period como a fonte de dados;
ABCDE._timeperiod - define um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados.

Padrão: DASHBOARD._timeperiod

Como alternativa, você pode definir o período de tempo apenas nos parâmetros From e To.
From 1 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.).

Comportamento do parâmetro:
- suportado se Time period não estiver definido
- obrigatório se time_period.to estiver definido
To 1 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.).

Comportamento do parâmetro:
- suportado se Time period não estiver definido
- obrigatório se time_period.from estiver definido
Show legend 0 show_legend 0 - Desativado;
1 - (padrão) Ativado.
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 Host do dashboard como a fonte de dados para hosts.

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Columns 0 columns Os valores possíveis variam de 1 a 24.

Padrão: 2.
Rows 0 rows Os valores possíveis variam de 1 a 16.

Padrão: 1.
Reference 1 reference Qualquer valor de string composto por 5 caracteres (por exemplo, ABCDE ou JBPNL). Esse valor deve ser exclusivo no 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 dashboard para o widget Protótipo de gráfico. Para obter mais informações sobre como configurar um dashboard, consulte dashboard.create.

Configurando um widget Protótipo de gráfico

Configure um widget Protótipo de gráfico que exibe uma grade de 3 gráficos (3 colunas, 1 linha) criados a partir de um protótipo de item (ID: "42316") por descoberta de baixo nível.

Requisição:

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

Resposta:

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

Veja também