[comment]: # ({11ceac39-893a57b4})
# 21 Top hosts

[comment]: # ({/11ceac39-893a57b4})

[comment]: # ({cf47196c-1b9f777d})
### Descrição

Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget do painel permitem configurar o widget  [*Top hosts*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/top_hosts) nos métodos `dashboard.create` e `dashboard.update` .

::: noteimportant
As propriedades do widget `fields`  não são validadas durante a criação ou atualização de um painel.
Isso permite que os usuários modifiquem [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) e criem [custom widgets](/manual/modules#developing-modules), mas também introduz o risco de criar ou atualizar widgets incorretamente.
Para garantir a criação ou atualização bem-sucedida do widget *Top hosts*, consulte os requisitos de parâmetros descritos nas tabelas abaixo.
:::

[comment]: # ({/cf47196c-1b9f777d})

[comment]: # ({65af6318-342177fd})
### Parâmetros

Os seguintes parâmetros são suportados para o widget *Top Hosts*.

|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-|--------|--|--------|-------------------------------|
|*Refresh interval*|<|0|rf_rate|0 - Sem atualização;<br>10 - 10 segundos;<br>30 - 30 segundos;<br>60 - *(padrão)* 1 minuto;<br>120 - 2 minutos;<br>600 - 10 minutos;<br>900 - 15 minutos.|
|*Host groups*|<|2|groupids|[Host group](/manual/api/reference/hostgroup/get) ID.<br><br>Note: Para configurar vários host groups, crie um objeto de campo de widget de painel para cada host.|
|*Hosts*|<|3|hostids|[Host](/manual/api/reference/host/get) ID.<br><br>Note: Para configurar múltiplos hots, crie um objeto de campo de widget de painel para cada host. Para múltiplos hosts, o parâmetro *Host groups* não deve ser configurado ou configurado com pelo menos um  host group ao qual os hosts configurados pertencem.|
|*Host Tags* (the number in the property name (e.g. tags.tag.0) references tag order in the tag evaluation list)|<|<|<|<|
|<|*Evaluation type*|0|evaltype|0 - *(padrão)* E/Ou;<br>2 - Ou.|
|^|*Tag name*|1|tags.tag.0|Qualquer valor da string.<br><br>Parâmetro *Nome da Tag* é necessário se estiver configurando as *Tags*.|
|^|*Operator*|0|tags.operator.0|0 - Contém;<br>1 - Igual;<br>2 - Não contém;<br>3 - Não é igual;<br>4 - Existe;<br>5 - Não existe.<br><br>Parâmetro *Operador* é necessário se estiver configurando as *Tags*.|
|^|*Tag value*|1|tags.value.0|Qualquer valor da string.<br><br>Parâmetro *Valor da tag* é necessário se estiver configurando as *Tags*.|
|*Columns* (see below)|<|<|<|<|
|*Order*|<|0|order|2 - *(padrão)* Top N;<br>3 - Botão N.|
|*Order column*|<|0|column| Valor númerico da coluna configurada |
|*Host count*|<|0|count|Valores válidos variam entre 1-100.<br><br>Padrão: 10.|

[comment]: # ({/65af6318-342177fd})

[comment]: # ({ebf9b848-14b55db3})
#### Colunas

As colunas possuem parâmetros comuns e parâmetros adicionais dependendo da configuração do parâmetro *Data*.

::: noteclassic
Para todos os parâmetros relacionados a colunas, o número no nome da propriedade (por exemplo, columsn.name.0) refere-se a uma coluna para qual o parâmetro está configurado. 
:::

[comment]: # ({/ebf9b848-14b55db3})

[comment]: # ({4f32414f-5321700b})
Os seguintes parâmetros são suportados por todas as colunas.

|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-----|-|-----|-------------------|
|*Name*|1|columns.name.0|Qualquer valor da string.|
|***Data***<br>(obrigatório)|0|columns.data.0|1 - Valor do item;<br>2 - Nome do host;<br>3 - Texto.|
|***Base color***<br>(obrigatório)|1|columns.base_color.0|Código de cor Hexadecimal (por exemplo, `FF0000`).|

[comment]: # ({/4f32414f-5321700b})

[comment]: # ({fb080973-931aceef})
##### Valor do item 

Os seguintes parâmetros são suportados se *Data* estiver configurado como "Valor do item".

::: noteclassic
O primeiro número no nome da propriedade *Thresholds* (por exemplo, columnsthresholds.color.0.0) refere-se à coluna para qual os thresholds estão configurados, enquanto o segundo número faz referência à posição dos thresholds em uma lista, ordenada em ordem crescente.
Contudo, se thresholds estiverem configurados em uma ordem diferente, os valores serão ordenados em ordem crescente após a atualização da configuração do widget no frontend do Zabbix.

(por exemplo,  `"threshold.threshold.0":"5"` → `"threshold.threshold.0":"1"`; `"threshold.threshold.1":"1"` → `"threshold.threshold.1": "5"`).
:::

|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-|--------|--|--------|-------------------------------|
|*Item*|<|1 |columns.item.0|Valide o nome do item.|
|***Time shift***<br>(required)|<|1|columns.timeshift.0|Valide o valor numérico ou o tempo da string (por exemplo, `3600` ou `1h`).<br>Você pode usar [time suffixes](/manual/appendix/suffixes#time-suffixes). Valores negativos são permitidos.|
|*Aggregation function*|<|0|columns.aggregate_function.0|0 - *(padrão)* nenhum;<br>1 - min;<br>2 - max;<br>3 - média;<br>4 - contar;<br>5 - somar;<br>6 - primeiro;<br>7 - último.|
|*Aggregation interval*|<|1|columns.aggregate_interval.0|Valide o tempo da string (por exemplo, `3600`, `1h`, etc.).<br>Você pode usar [time suffixes](/manual/appendix/suffixes#time-suffixes).<br><br>Parâmetro *Intervalo de agregação* indisponível se *Função da agregação* estiver configurado como *none*.<br><br>Padrão: `1h`.|
|*Display*|<|0|columns.display.0|1 - *(padrão)* As is;<br>2 - Barra;<br>3 - Indicadores.|
|*Min*|<|1|columns.min.0|Qualquer valor numérico.<br><br>Parâmetro *Min* indisponível se *Display* estiver configurado como "As is".|
|*Max*|<|1|columns.max.0|Qualquer valor numérico.<br><br>Parâmetro *Max* indisponível se *Display* estiver configurado como "As is".|
|*History data*|<|0|columns.history.0|1 - *(padrão)* Automático;<br>2 - Histórico;<br>3 - Trends.|
|*Thresholds*|<|<|<|<|
|<|*Color*|1|columnsthresholds.color.0.0|Código de cor Hexadecimal (por exemplo, `FF0000`).<br><br>Padrão: `""` (vazio).|
|^|*Threshold*|1|columnsthresholds.threshold.0.0|Qualquer valor da string.|

[comment]: # ({/fb080973-931aceef})

[comment]: # ({9b7919cb-108ba0d5})
##### Texto

Os seguintes parâmetros são suportados se *Data* estiver configurado como "Texto".

|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|valor|
|-----|-|-----|-------------------|
|*Text*|1|columns.text.0|Qualquer valor da string, incluindo macros<br>Macros suportados: {HOST.\*}, {INVENTORY.\*}.<br><br>Parâmetro *Texto* obrigatório se *Data* estiver configurado como "Texto".|

[comment]: # ({/9b7919cb-108ba0d5})

[comment]: # ({e7eaa526-6098938f})
### Exemplos

Os seguintes exemplos têm como objetivo apenas descrever a configuração dos objetos de campo do widget do painel para o *Top hosts* widget.
Para mais informações sobre como configurar um painel, consulte [`dashboard.create`](/manual/api/reference/dashboard/create).

[comment]: # ({/e7eaa526-6098938f})

[comment]: # ({9dd290ec-f6735ae7})
#### Configurando um widget *Top hosts*

Configure um widget *Top hosts* que exibe os principais hosts por utilização da CPU no grupo de hosts "4"
Além disso, configure as colunas personalizadas a seguir: "Nome do host", "Utilização", "1m avg", "5m avg", "15m avg", "Processos".

Requisição:

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "tophosts",
                        "name": "Top hosts",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids",
                                "value": 4
                            },
                            {
                                "type": 1,
                                "name": "columns.name.0",
                                "value": ""
                            },
                            {
                                "type": 0,
                                "name": "columns.data.0",
                                "value": 2
                            },
                            {
                                "type": 1,
                                "name": "columns.base_color.0",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.timeshift.0",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "columns.name.1",
                                "value": "Utilization"
                            },
                            {
                                "type": 0,
                                "name": "columns.data.1",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.base_color.1",
                                "value": "4CAF50"
                            },
                            {
                                "type": 1,
                                "name": "columns.timeshift.1",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "columns.item.1",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "columns.display.1",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "columns.min.1",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "columns.max.1",
                                "value": "100"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.color.1.0",
                                "value": "FFFF00"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.threshold.1.0",
                                "value": "50"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.color.1.1",
                                "value": "FF8000"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.threshold.1.1",
                                "value": "80"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.color.1.2",
                                "value": "FF4000"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.threshold.1.2",
                                "value": "90"
                            },
                            {
                                "type": 1,
                                "name": "columns.name.2",
                                "value": "1m avg"
                            },
                            {
                                "type": 0,
                                "name": "columns.data.2",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.base_color.2",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.timeshift.2",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "columns.item.2",
                                "value": "Load average (1m avg)"
                            },
                            {
                                "type": 1,
                                "name": "columns.name.3",
                                "value": "5m avg"
                            },
                            {
                                "type": 0,
                                "name": "columns.data.3",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.base_color.3",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.timeshift.3",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "columns.item.3",
                                "value": "Load average (5m avg)"
                            },
                            {
                                "type": 1,
                                "name": "columns.name.4",
                                "value": "15m avg"
                            },
                            {
                                "type": 0,
                                "name": "columns.data.4",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.base_color.4",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.timeshift.4",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "columns.item.4",
                                "value": "Load average (15m avg)"
                            },
                            {
                                "type": 1,
                                "name": "columns.name.5",
                                "value": "Processes"
                            },
                            {
                                "type": 0,
                                "name": "columns.data.5",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.base_color.5",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.timeshift.5",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "columns.item.5",
                                "value": "Number of processes"
                            },
                            {
                                "type": 0,
                                "name": "column",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Resposta:

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

[comment]: # ({/9dd290ec-f6735ae7})

[comment]: # ({e9d30322-a8f0e2bb})
## Veja também

-[Campo widget do dashboard](/manual/api/reference/dashboard/object#dashboard-widget-field)
-[`dashboard.create`](/manual/api/reference/dashboard/create)
-[`dashboard.update`](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-a8f0e2bb})
