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 compatíveis com o widget Protótipo de gráfico.

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.
Origem 0 source_type 2 - (padrão) Protótipo de gráfico;
3 - Protótipo de gráfico simples.
Protótipo de gráfico 7 graphid.0 ID do protótipo de gráfico.

Comportamento do parâmetro:
- obrigatório se Origem estiver definida como "Protótipo de gráfico"
Protótipo de item 5 itemid.0 ID do protótipo de item.

Comportamento do parâmetro:
- obrigatório se Origem estiver definida como "Protótipo de gráfico simples"
Período 1 time_period._reference DASHBOARD._timeperiod - define o seletor de Período como a origem dos dados;
ABCDE._timeperiod - define um widget compatível (com o parâmetro Referência definido como "ABCDE") como a origem dos dados.

Padrão: DASHBOARD._timeperiod

Como alternativa, você pode definir o período somente 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 relativa (now, now/d, now/w-1w, etc.).

Comportamento do parâmetro:
- compatível se Período 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 relativa (now, now/d, now/w-1w, etc.).

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

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

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

Padrão: 1.
Referência 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