[comment]: # ({8c8dd5c7-978cbb20})
# 28 Principais hosts
[comment]: # ({/8c8dd5c7-978cbb20})
[comment]: # ({4e99026f-c5138763})
### 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 [*Top hosts*](/manual/web_interface/frontend_sections/dashboards/widgets/top_hosts) nos métodos `dashboard.create` e `dashboard.update`.
::: noteimportant
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](/manual/web_interface/frontend_sections/dashboards/widgets) e criem [widgets personalizados](/devel/modules/tutorials/widget), 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 o comportamento dos parâmetros descrito nas tabelas abaixo.
:::
[comment]: # ({/4e99026f-c5138763})
[comment]: # ({6c1cb502-224c01f4})
### Parâmetros
Os seguintes parâmetros são suportados para o widget *Top hosts*.
|Parâmetro|<|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|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.|
|*Grupos de hosts*|<|2|groupids.0|ID do [Grupo de hosts](/manual/api/reference/hostgroup/get).
Nota: Para configurar múltiplos grupos de hosts, crie um objeto de campo de widget de dashboard para cada grupo de hosts com um número incrementado no nome da propriedade.
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|<|*Grupos de hosts (Widget)*|1|groupids.\_reference|Em vez do ID do [Grupo de hosts](/manual/api/reference/hostgroup/get):
`ABCDE._hostgroupids` - defina um [widget compatível](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (com seu parâmetro *Referência* definido como "`ABCDE`") como a fonte de dados para grupos de hosts.
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|*Hosts*|<|3|hostids.0|ID do [Host](/manual/api/reference/host/get).
Nota: Para configurar múltiplos hosts, crie um objeto de campo de widget de dashboard para cada host com um número incrementado no nome da propriedade. Para múltiplos hosts, o parâmetro *Grupos de hosts* deve não estar configurado ou estar configurado com pelo menos um grupo de hosts ao qual os hosts configurados pertençam.
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|<|*Hosts (Widget/Dashboard)*|1|hostids.\_reference|Em vez do ID do [Host](/manual/api/reference/host/get):
`DASHBOARD.hostids` - defina o [seletor de host](/manual/web_interface/frontend_sections/dashboards/widgets#override-host) do dashboard como a fonte de dados para hosts;
`ABCDE._hostids` - defina um [widget compatível](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (com seu parâmetro *Referência* definido como "`ABCDE`") como a fonte de dados para hosts.
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|*Tags de host*|<|<|<|<|
|<|*Tipo de avaliação*|0|evaltype|0 - *(padrão)* E/Ou;
2 - Ou.
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|^|*Nome da tag*|1|tags.0.tag|Qualquer valor de string.
Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se estiver configurando *Tags de host*
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|^|*Operador*|0|tags.0.operator|0 - Contém;
1 - Igual;
2 - Não contém;
3 - Diferente;
4 - Existe;
5 - Não existe.
Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se estiver configurando *Tags de host*
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|^|*Valor da tag*|1|tags.0.value|Qualquer valor de string.
Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se estiver configurando *Tags de host*
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|*Mostrar hosts em manutenção*|<|0|maintenance|0 - *(padrão)* Desabilitado;
1 - Habilitado.|
|*Colunas* (veja abaixo)|<|<|<|<|
|*Ordenar por*|<|0|column|Valor numérico da coluna das colunas configuradas.|
|*Ordem*|<|0|order|2 - *(padrão)* Top N;
3 - Bottom N.|
|*Limite de hosts*|<|0|show_lines|Os valores possíveis variam de 1-1000.
Padrão: 10.
Este parâmetro não é suportado se estiver configurando o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
[comment]: # ({/6c1cb502-224c01f4})
[comment]: # ({e8e68707-8266fc04})
#### 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 às colunas, o número no nome da propriedade (por exemplo, columns.0.name) faz referência a uma coluna para a qual o parâmetro está configurado.
:::
[comment]: # ({/e8e68707-8266fc04})
[comment]: # ({e35e7f37-bba2be85})
Os seguintes parâmetros são suportados para todas as colunas.
|Parâmetro|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-----|-|-----|-------------------|
|*Nome*|1|columns.0.name|Qualquer valor de string.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório*|
|*Dados*|0|columns.0.data|1 - Valor do item;
2 - Nome do host;
3 - Texto.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório*|
|*Cor base*|1|columns.0.base_color|Código de cor hexadecimal (por exemplo, `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório*|
[comment]: # ({/e35e7f37-bba2be85})
[comment]: # ({02077e27-5843843c})
##### Valor do item
Os seguintes parâmetros são suportados se *Dados* estiver definido como "Valor do item".
::: noteclassic
O primeiro número no nome da propriedade *Thresholds* (por exemplo, columnsthresholds.0.color.0) faz referência à coluna para a qual os thresholds estão configurados, enquanto o segundo número faz referência à posição do threshold em uma lista, ordenada em ordem crescente.
No entanto, se os thresholds forem 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.0.threshold":"5"` → `"threshold.0.threshold":"1"`; `"threshold.1.threshold":"1"` → `"threshold.1.threshold": "5"`).
:::
|Parâmetro|<|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-|--------|--|--------|-------------------------------|
|*Item*|<|1 |columns.0.item|Nome de item válido.
Ao configurar o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object), apenas os items configurados no template devem ser definidos.|
|*Exibir valor do item como*|<|0|columns.0.display_value_as|0 - *(padrão)* Numérico;
1 - Texto;
2 - Binário.|
|*Exibir*|<|0|columns.0.display|1 - *(padrão)* Como está;
2 - Barra;
3 - Indicadores;
6 - Sparkline.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico"|
|*Mínimo*|<|1|columns.0.min|Qualquer valor numérico.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Barra" ou "Indicadores"|
|*Máximo*|<|1|columns.0.max|Qualquer valor numérico.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Barra" ou "Indicadores"|
|*Casas decimais*|<|0|columns.0.decimal_places|Os valores possíveis variam de 0-10.
Padrão: 2.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico"|
|*Sparkline*|<|<|<|<|
|<|*Largura*|0|columns.0.sparkline.width|Os valores possíveis variam de 0-10.
Padrão: 1.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"|
|^|*Preenchimento*|0|columns.0.sparkline.fill|Os valores possíveis variam de 0-10.
Padrão: 3.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"|
|^|*Cor*|1|columns.0.sparkline.color|Código de cor hexadecimal (por exemplo, `FF0000`).
Padrão: `42A5F5`.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"|
|^|*Período de tempo*|1|columns.0.sparkline.time_period.\_reference|`DASHBOARD._timeperiod` - define o [seletor de período de tempo](/manual/web_interface/time_period_selector) do dashboard como fonte de dados;
`ABCDE._timeperiod` - define um [widget compatível](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (com seu parâmetro `reference` igual a `ABCDE`) como fonte de dados.
Padrão: `DASHBOARD._timeperiod`
Alternativamente, você pode definir o período de tempo apenas nos parâmetros *De* e *Até*.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"|
|^|*De*|1|columns.0.sparkline.time_period.from|String de tempo válida no formato absoluto (`YYYY-MM-DD hh:mm:ss`) ou na sintaxe de tempo [relativo](/manual/web_interface/time_period_selector) (`now`, `now/d`, `now/w-1w`, etc.).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"
- *obrigatório* se `columns.0.sparkline.time_period.to` estiver definido|
|^|*Até*|1|columns.0.sparkline.time_period.to|String de tempo válida no formato absoluto (`YYYY-MM-DD hh:mm:ss`) ou na sintaxe de tempo [relativo](/manual/web_interface/time_period_selector) (`now`, `now/d`, `now/w-1w`, etc.).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"
- *obrigatório* se `columns.0.sparkline.time_period.from` estiver definido|
|^|*Dados históricos*|0|columns.0.sparkline.history|0 - *(padrão)* Automático;
1 - Histórico;
2 - Tendências.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico" e *Exibir* estiver definido como "Sparkline"|
|*Thresholds*|<|<|<|<|
|<|*Cor*|1|columnsthresholds.0.color.0|Código de cor hexadecimal (por exemplo, `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico"|
|^|*Threshold*|1|columnsthresholds.0.threshold.0|Qualquer valor de string.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico"|
|*Destaques*|<|<|<|<|
|<|*Cor*|1|columns.0.highlights.0.color|Código de cor hexadecimal (por exemplo, `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Texto"|
|^|*Padrão*|1|columns.0.highlights.0.pattern|Qualquer valor de string.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Texto"|
|*Exibir miniatura*|<|0|columns.0.show_thumbnail|0 - *(padrão)* Desabilitado;
1 - Habilitado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Binário"|
|*Função de agregação*|<|0|columns.0.aggregate_function|0 - *(padrão)* não usado;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.|
|*Período de tempo*|<|1|columns.0.time_period.\_reference|`DASHBOARD._timeperiod` - define o [seletor de período de tempo](/manual/web_interface/time_period_selector) do dashboard como fonte de dados;
`ABCDE._timeperiod` - define um [widget compatível](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (com seu parâmetro `reference` igual a `ABCDE`) como fonte de dados.
Padrão: `DASHBOARD._timeperiod`
Alternativamente, você pode definir o período de tempo apenas nos parâmetros *De* e *Até*.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Função de agregação* estiver definida como "min", "max", "avg", "count", "sum", "first", "last"|
|<|*De*|1|columns.0.time_period.from|String de tempo válida no formato absoluto (`YYYY-MM-DD hh:mm:ss`) ou na sintaxe de tempo [relativo](/manual/web_interface/time_period_selector) (`now`, `now/d`, `now/w-1w`, etc.).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Período de tempo* não estiver definido e *Função de agregação* estiver definida como "min", "max", "avg", "count", "sum", "first", "last"
- *obrigatório* se `columns.0.time_period.to` estiver definido|
|^|*Até*|1|columns.0.time_period.to|String de tempo válida no formato absoluto (`YYYY-MM-DD hh:mm:ss`) ou na sintaxe de tempo [relativo](/manual/web_interface/time_period_selector) (`now`, `now/d`, `now/w-1w`, etc.).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Período de tempo* não estiver definido e *Função de agregação* estiver definida como "min", "max", "avg", "count", "sum", "first", "last"
- *obrigatório* se `columns.0.time_period.from` estiver definido|
|*Dados históricos*|<|0|columns.0.history|0 - *(padrão)* Automático;
1 - Histórico;
2 - Tendências.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor do item como* estiver definido como "Numérico"|
|*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](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório*|
[comment]: # ({/02077e27-5843843c})
[comment]: # ({55d0acdb-18fd738d})
##### Texto
Os seguintes parâmetros são suportados se *Data* estiver definido como "Texto".
|Parâmetro|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-----|-|-----|-------------------|
|*Texto*|1|columns.0.text|Qualquer valor de string, incluindo macros.
Macros suportadas: {HOST.\*}, {INVENTORY.\*}.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se *Data* estiver definido como "Texto"|
[comment]: # ({/55d0acdb-18fd738d})
[comment]: # ({e7eaa526-c274247c})
### Exemplos
Os exemplos a seguir têm como objetivo apenas descrever a configuração dos objetos de campo do widget de dashboard para o widget *Top hosts*.
Para mais informações sobre como configurar um dashboard, consulte [`dashboard.create`](/manual/api/reference/dashboard/create).
[comment]: # ({/e7eaa526-c274247c})
[comment]: # ({ec72cf7d-2e9b79c3})
#### Configurando um widget *Top hosts*
Configure um widget *Top hosts* que exibe os principais hosts por utilização de CPU no grupo de hosts "4".
Além disso, configure as seguintes colunas personalizadas: "Nome do host", "Utilização da CPU em %", "1m avg", "5m avg", "15m avg", "Processos".
[Requisição](/manual/api#performing-requests):
```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": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
[comment]: # ({/ec72cf7d-2e9b79c3})
[comment]: # ({e9d30322-d8c32fe2})
### Veja também
- [Campo de 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-d8c32fe2})