[comment]: # ({37c3aad7-37c3aad7})
# dhost.get

[comment]: # ({/37c3aad7-37c3aad7})

[comment]: # ({a1812e61-1309d6bb})
### Descrição

`integer/array dhost.get(object parameters)`

O método permite recuperar hosts descobertos de acordo com os parâmetros fornecidos.

::: noteclassic
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

[comment]: # ({/a1812e61-1309d6bb})

[comment]: # ({5f644960-061d7cf0})
### Parâmetros

`(object)` Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|dhostids|ID/array|Retorna apenas hosts descobertos com os IDs fornecidos.|
|druleids|ID/array|Retorna apenas hosts descobertos que foram criados pelas regras de descoberta fornecidas.|
|dserviceids|ID/array|Retorna apenas hosts descobertos que estão executando os serviços fornecidos.|
|selectDRules|query|Retorna uma propriedade [`drules`](/manual/api/reference/drule/object) com um array das regras de descoberta que detectaram o host.|
|selectDServices|query|Retorna uma propriedade [`dservices`](/manual/api/reference/dservice/object) com os serviços descobertos em execução no host.<br><br>Suporta `count`.|
|limitSelects|integer|Limita o número de registros retornados por subconsultas.<br><br>Aplica-se às seguintes subconsultas:<br>`selectDServices` - os resultados serão classificados por `dserviceid`.|
|sortfield|string/array|Classifica o resultado pelas propriedades fornecidas.<br><br>Valores possíveis: `dhostid`, `druleid`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5f644960-061d7cf0})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(integer/array)` Retorna:

-   um array de objetos;
-   a contagem de objetos recuperados, se o parâmetro `countOutput` foi utilizado.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({c08efc78-4b9c1e99})
#### Recuperar hosts descobertos por regra de descoberta

Recupera todos os hosts e os serviços descobertos que estão em execução e que foram detectados pela regra de descoberta "4".

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "dhost.get",
    "params": {
        "output": "extend",
        "selectDServices": "extend",
        "druleids": "4"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "dservices": [
                {
                    "dserviceid": "1",
                    "dhostid": "1",
                    "type": "4",
                    "key_": "",
                    "value": "",
                    "port": "80",
                    "status": "0",
                    "lastup": "1337697227",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.1",
                    "dns": "station.company.lan"
                }
            ],
            "dhostid": "1",
            "druleid": "4",
            "status": "0",
            "lastup": "1337697227",
            "lastdown": "0"
        },
        {
            "dservices": [
                {
                    "dserviceid": "2",
                    "dhostid": "2",
                    "type": "4",
                    "key_": "",
                    "value": "",
                    "port": "80",
                    "status": "0",
                    "lastup": "1337697234",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.4",
                    "dns": "john.company.lan"
                }
            ],
            "dhostid": "2",
            "druleid": "4",
            "status": "0",
            "lastup": "1337697234",
            "lastdown": "0"
        },
        {
            "dservices": [
                {
                    "dserviceid": "3",
                    "dhostid": "3",
                    "type": "4",
                    "key_": "",
                    "value": "",
                    "port": "80",
                    "status": "0",
                    "lastup": "1337697234",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.26",
                    "dns": "printer.company.lan"
                }
            ],
            "dhostid": "3",
            "druleid": "4",
            "status": "0",
            "lastup": "1337697234",
            "lastdown": "0"
        },
        {
            "dservices": [
                {
                    "dserviceid": "4",
                    "dhostid": "4",
                    "type": "4",
                    "key_": "",
                    "value": "",
                    "port": "80",
                    "status": "0",
                    "lastup": "1337697234",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.7",
                    "dns": "mail.company.lan"
                }
            ],
            "dhostid": "4",
            "druleid": "4",
            "status": "0",
            "lastup": "1337697234",
            "lastdown": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/c08efc78-4b9c1e99})

[comment]: # ({184a9e84-e6b09247})
### Veja também

-   [Serviço descoberto](/manual/api/reference/dservice/object#discovered-service)
-   [Regra de descoberta](/manual/api/reference/drule/object#discovery-rule)

[comment]: # ({/184a9e84-e6b09247})

[comment]: # ({8dc0c01a-8dc0c01a})
### Fonte

CDHost::get() em *ui/include/classes/api/services/CDHost.php*.

[comment]: # ({/8dc0c01a-8dc0c01a})