[comment]: # translation:outdated

[comment]: # ({70dbc2c9-70dbc2c9})
# proxy.get

[comment]: # ({/70dbc2c9-70dbc2c9})

[comment]: # ({fea54630-b91ae38b})
### Описание

`integer/array proxy.get(параметры объекта)`

Этот метод позволяет получать прокси в соответствии с заданными
параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/fea54630-b91ae38b})

[comment]: # ({new-74f0aaac})
### Параметры

`(объект)` Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

|Параметр|Тип|Описание|
|----------------|------|----------------|
|proxyids|строка/массив|Возврат прокси только с заданными ID.|
|selectHosts|запрос|Возврат узлов сети, которые наблюдаются через прокси, в свойстве `hosts`.|
|selectInterface|запрос|Возврат интерфейса прокси, который используется пассивным прокси, в свойстве `interface`.|
|sortfield|строка/массив|Сортировка результата в соответствии с заданными свойствами.<br><br>Возможные значения: `hostid`, `host` и `status`.|
|countOutput|логический|Эти параметры являются общими для всех методов `get` и они описаны в [справочных комментариях](/ru/manual/api/reference_commentary#общие_параметры_get_метода).|
|editable|логический|^|
|excludeSearch|логический|^|
|filter|объект|^|
|limit|целое число|^|
|output|запрос|^|
|preservekeys|фл логический аг|^|
|search|объект|^|
|searchByAny|логический|^|
|searchWildcardsEnabled|логический|^|
|sortorder|строка/массив|^|
|startSearch|логический|^|

[comment]: # ({/new-74f0aaac})

[comment]: # ({229e380f-7223bab1})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Примеры

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

[comment]: # ({c313162c-b40fb513})
#### Получение всех прокси

Получить все сконфигурированные прокси и их интерфейсы.

Запрос:

```json
{
    "jsonrpc": "2.0",
    "method": "proxy.get",
    "params": {
        "output": "extend",
        "selectInterface": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "host": "Active proxy",
            "status": "5",
            "lastaccess": "0",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "proxy_address": "",
            "auto_compress": "0",
            "proxyid": "30091",
            "interface": []
        },
        {
            "host": "Passive proxy",
            "status": "6",
            "lastaccess": "0",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "proxy_address": "",
            "auto_compress": "0",
            "proxyid": "30092",
            "interface": {
                "interfaceid": "30109",
                "hostid": "30092",
                "useip": "1",
                "ip": "127.0.0.1",
                "dns": "",
                "port": "10051"
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/c313162c-b40fb513})

[comment]: # ({273e0fd8-273e0fd8})
### Смотрите также

-   [Узел сети](/manual/api/reference/host/object#host)
-   [Интерфейс прокси](object#proxy_interface)

[comment]: # ({/273e0fd8-273e0fd8})

[comment]: # ({b9a96f2c-b9a96f2c})
### Источник

CProxy::get() в *ui/include/classes/api/services/CProxy.php*.

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