proxy.get

Description

целое число/массив proxy.get(объект параметры)

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

Параметры

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

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

Параметр	Тип	Описание
proxyids	строка/массив	Возврат прокси только с заданными ID.
selectHosts	запрос	Возврат узлов сети, которые наблюдаются через прокси, в свойстве `hosts`.
selectInterface	запрос	Возврат интерфейса прокси, который используется пассивным прокси, в свойстве `interface`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `hostid`, `host` и `status`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
nodeids	строка/массив
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг
~~selectInterfaces~~ (устаревший)	запрос	Возврат интерфейса прокси, который используется пассивным прокси, в виде массива в свойстве `interfaces`.

Возвращаемые значения

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

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

Примеры

Получение всех прокси

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

Запрос:

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

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "interface": [],
                   "host": "Active proxy",
                   "status": "5",
                   "lastaccess": "0",
                   "proxyid": "30091"
               },
               {
                   "interface": {
                       "interfaceid": "30109",
                       "hostid": "30092",
                       "useip": "1",
                       "ip": "127.0.0.1",
                       "dns": "",
                       "port": "10051"
                   ],
                   "host": "Passive proxy",
                   "status": "6",
                   "lastaccess": "0",
                   "proxyid": "30092"
               }
           ],
           "id": 1
       }

Смотрите также

Исходный код

CProxy::get() в frontends/php/api/classes/CProxy.php.

Documentation