proxygroup.get

Опис

integer/array proxygroup.get(object parameters)

Метода омогућава преузимање прокси група према датим параметрима.

Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Улоге корисника за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Овај метод подржава следеће параметре.

Parameter	Type	Description
proxy_groupids	ID/array	Враћа само прокси групе са датим ID-ијевима.
proxyids	ID/array	Враћа само прокси групе који садрже дате прокси сервере.
selectProxies	query	Враћа својство `proxies` са проксијима који припадају групи проксија. Подржава `count`.
sortfield	string/array	Сортирај резултат према датим својствима. Могуће вредности су: `proxy_groupid`, `name`.
countOutput	boolean	Ови параметри заједнички за све `get` методе, описани су детаљно у референтном коментару.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Повратне вредности

(integer/array) Враћа или:

низ објеката;
број преузетих објеката, ако је коришћен параметар countOutput.

Примери

Преузимање свих прокси група

Преузмите све конфигурисане прокси групе са проксијима.

Захтев:

{
           "jsonrpc": "2.0",
           "method": "proxygroup.get",
           "params": {
               "output": "extend",
               "selectProxies": ["proxyid", "name"]
           },
           "id": 1
       }

Одговор:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "proxy_groupid": "1",
                   "name": "Proxy group 1",
                   "failover_delay": "1m",
                   "min_online": "3",
                   "description": "",
                   "state": "1",
                   "proxies": [
                       {
                           "proxyid": "1",
                           "name": "proxy 1"
                       },
                       {
                           "proxyid": "2",
                           "name": "proxy 2"
                       }
                   ]
               },
               {
                   "proxy_groupid": "2",
                   "name": "Proxy group 2",
                   "failover_delay": "10m",
                   "min_online": "3",
                   "description": "",
                   "state": "3",
                   "proxies": [
                       {
                           "proxyid": "3",
                           "name": "proxy 3"
                       },
                       {
                           "proxyid": "4",
                           "name": "proxy 4"
                       },
                       {
                           "proxyid": "5",
                           "name": "proxy 5"
                       }
                   ]
               }
           ],
           "id": 1
       }

Погледајте такође

Прокси

Извор

CProxyGroup::get() у ui/include/classes/api/services/CProxyGroup.php.

Documentation