[comment]: # translation:outdated [comment]: # ({f8d4c2e5-f8d4c2e5}) ## hostgroup.get [comment]: # ({/f8d4c2e5-f8d4c2e5}) [comment]: # ({71a80804-08ff22f2}) ### Descrição `integer/array hostgroup.get(object parameters)` O método permite recuperar grupos de hosts de acordo com o dado parâmetros. ::: noteclassic Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja [Usuário funções](/manual/web_interface/frontend_sections/administration/user_roles) Para maiores informações. ::: [comment]: # ({/71a80804-08ff22f2}) [comment]: # ({f075918f-7f042696}) ### Parâmetros `(object)` Parâmetros que definem a saída desejada. O método oferece suporte aos parâmetros a seguir. |Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |---------|----------------------------------- ------------|-----------| |graphids|string/array|Retorna apenas grupos de hosts que contêm hosts ou modelos com os gráficos fornecidos.| |groupids|string/array|Retorna apenas grupos de hosts com os IDs de grupos de hosts fornecidos.| |hostids|string/array|Retorna apenas grupos de hosts que contêm os hosts fornecidos.| |maintenanceids|string/array|Retorna apenas os grupos de hosts afetados pelas manutenções fornecidas.| |monitored\_hosts|flag|Retorna apenas grupos de hosts que contêm hosts monitorados.| |real\_hosts|flag|Retorna apenas grupos de hosts que contêm hosts.| |templated\_hosts|flag|Retorna apenas grupos de hosts que contêm templates.| |templateids|string/array|Retorna apenas grupos de hosts que contêm os modelos fornecidos.| |triggerids|string/array|Retorna apenas grupos de hosts que contêm hosts ou modelos com os gatilhos fornecidos.| |with\_graphs|flag|Retorna apenas grupos de hosts que contêm hosts com gráficos.| |with\_graph\_prototypes|flag|Retorna apenas grupos de hosts que contêm hosts com protótipos de gráficos.| |with\_hosts\_and\_templates|flag|Retorne apenas grupos de hosts que contenham hosts *ou* templates.| |with\_httptests|flag|Retorna apenas grupos de hosts que contêm hosts com verificações da web.

Substitui o parâmetro `with_monitored_httptests`.| |with\_items|flag|Retorna apenas grupos de hosts que contenham hosts ou templates com itens.

Substitui os parâmetros `with_monitored_items` e`with_simple_graph_items`.| |with\_item\_prototypes|flag|Retorna apenas grupos de hosts que contêm hosts com protótipos de itens.

Substitui o parâmetro `with_simple_graph_item_prototypes`.| |with\_simple\_graph\_item\_prototypes|flag|Retorna apenas grupos de hosts que contêm hosts com protótipos de itens, que são ativados para criação e possuem informações do tipo numérico.| |with\_monitored\_httptests|flag|Retorna apenas grupos de hosts que contenham hosts com verificações da web habilitadas.| |with\_monitored\_items|flag|Retorna apenas grupos de hosts que contenham hosts ou templates com itens habilitados.

Substitui o parâmetro `with_simple_graph_items`.| |with\_monitored\_triggers|flag|Retorna apenas grupos de hosts que contêm hosts com acionadores ativados. Todos os itens usados no gatilho também devem estar habilitados.| |with\_simple\_graph\_items|flag|Retorna apenas grupos de hosts que contenham hosts com itens numéricos.| |with\_triggers|flag|Retorna apenas grupos de hosts que contêm hosts com gatilhos.

Substitui o parâmetro `with_monitored_triggers`.| |selectDiscoveryRule|query|Retorne uma propriedade [discoveryRule](/manual/api/reference/drule/object) com a regra LLD que criou o grupo de hosts.| |selectGroupDiscovery|query|Retorne uma propriedade `groupDiscovery` com o objeto de descoberta do grupo de hosts.

O objeto de descoberta do grupo de hosts vincula um grupo de hosts descoberto a um protótipo de grupo de hosts e tem as seguintes propriedades:
`groupid ` - `(string)` ID do grupo de hosts descoberto;
`lastcheck` - `(timestamp)` hora em que o grupo de hosts foi descoberto pela última vez;
`name` - `(string)` nome do protótipo do grupo de hosts;
`parent_group_prototypeid` - `(string)` ID do protótipo do grupo de hosts a partir do qual o grupo de hosts foi criado;
`ts_delete` - `(timestamp)` hora em que um grupo de hosts que é não mais descoberto será excluído.| |selectHosts|query|Retorne uma propriedade [hosts](/manual/api/reference/host/object) com os hosts que pertencem ao grupo de hosts.

Suporta `count`.| |selectTemplates|query|Retorne uma propriedade [templates](/manual/api/reference/template/object) com os templates que pertencem ao grupo de hosts.

Suporta `count`.| |limitSelects|integer|Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
`selectHosts` - os resultados serão classificados por `host`;
`selectTemplates` - resultados será ordenado por `host`.| |sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: `groupid`, `name`.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes na página [comentário de referência](/manual/api/reference_commentary#common_get_method_parameters).| |editável|booleano|^| |excludePesquisa|boolean|^| |filtro|objeto|^| |limite|inteiro|^| |saída|consulta|^| |preservekeys|boolean|^| |pesquisar|objeto|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |ordem de classificação|cadeia/matriz|^| |startSearch|boolean|^| [comment]: # ({/f075918f-7f042696}) [comment]: # ({7223bab1-7223bab1}) ### Valores de retorno `(integer/array)` Retorna: - uma matriz de objetos; - a contagem de objetos recuperados, se o parâmetro `countOutput` tiver sido usado. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Exemplos [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({2f614589-8ed2756a}) #### Recuperando dados por nome Recupere todos os dados sobre dois grupos de hosts chamados "servidores Zabbix" e "Servidores Linux". Solicitação: ``` {.java} { "jsonrpc": "2.0", "método": "hostgroup.get", "parâmetros": { "saída": "estender", "filtro": { "nome": [ "servidores Zabbix", "Servidores Linux" ] } }, "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0", "id": 1 } ``` Resposta: ``` {.java} { "jsonrpc": "2.0", "resultado": [ { "groupid": "2", "name": "Servidores Linux", "interno": "0" }, { "groupid": "4", "name": "servidores Zabbix", "interno": "0" } ], "id": 1 } ``` [comment]: # ({/2f614589-8ed2756a}) [comment]: # ({eed86cbd-e5f0abe1}) ### Veja também - [Host](/manual/api/reference/host/object#host) - [Modelo](/manual/api/reference/template/object#template) [comment]: # ({/eed86cbd-e5f0abe1}) [comment]: # ({1e72ea39-1e72ea39}) ### Fonte CHostGroup::get() em *ui/include/classes/api/services/CHostGroup.php*. [comment]: # ({/1e72ea39-1e72ea39})