[comment]: # ({25793162-25793162})
# hostinterface.get

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

[comment]: # ({435918f1-29074792})
### Descrição

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

O método permite recuperar interfaces de host 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]: # ({/435918f1-29074792})

[comment]: # ({8c45a3cb-a40e6018})
### 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|
|--|--|------|
|hostids|ID/array|Retorna apenas as interfaces de host usadas pelos hosts fornecidos.|
|interfaceids|ID/array|Retorna apenas as interfaces de host com os IDs fornecidos.|
|itemids|ID/array|Retorna apenas as interfaces de host usadas pelos itens fornecidos.|
|triggerids|ID/array|Retorna apenas as interfaces de host usadas pelos itens nos triggers fornecidos.|
|selectItems|query|Retorna uma propriedade [`items`](/manual/api/reference/item/object) com os itens que usam a interface.<br><br>Suporta `count`.|
|selectHosts|query|Retorna uma propriedade [`hosts`](/manual/api/reference/host/object) com um array de hosts que usam a interface.|
|limitSelects|integer|Limita o número de registros retornados por subconsultas.<br><br>Aplica-se às seguintes subconsultas:<br>`selectItems`.|
|sortfield|string/array|Ordena o resultado pelas propriedades fornecidas.<br><br>Valores possíveis: `interfaceid`, `dns`, `ip`.|
|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]: # ({/8c45a3cb-a40e6018})

[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]: # ({d7de2fbf-cbd2e952})
#### Recuperar interfaces de host

Recupera todos os dados sobre as interfaces usadas pelo host "30057".

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

```json
{
    "jsonrpc": "2.0",
    "method": "hostinterface.get",
    "params": {
        "output": "extend",
        "hostids": "30057"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "interfaceid": "50039",
            "hostid": "30057",
            "main": "1",
            "type": "1",
            "useip": "0",
            "ip": "",
            "dns": "localhost",
            "port": "10050",
            "available": "0",
            "error": "",
            "errors_from": "0",
            "disable_until": "0",
            "details": []
        },
        {
            "interfaceid": "55082",
            "hostid": "30057",
            "main": "1",
            "type": "2",
            "useip": "1",
            "ip": "127.0.0.1",
            "dns": "",
            "port": "161",
            "available": "0",
            "error": "",
            "errors_from": "0",
            "disable_until": "0",
            "details": {
                "version": "2",
                "bulk": "0",
                "community": "{$SNMP_COMMUNITY}",
                "max_repetitions": "10"
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/d7de2fbf-cbd2e952})

[comment]: # ({1c57700e-1c57700e})
### Veja também

-   [Host](/manual/api/reference/host/object#host)
-   [Item](/manual/api/reference/item/object#item)

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

[comment]: # ({d0cee877-d0cee877})
### Fonte

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

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