proxy.get

Opis

integer/array proxy.get(object parameters)

Metoda umożliwia pobranie serwerów proxy zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
proxyids	string/array	Zwróć tylko serwery proxy o podanych identyfikatorach.
selectHosts	query	Zwróć właściwość hosts z hostami monitorowanymi przez serwer proxy.
selectInterface	query	Zwróć właściwość interface z interfejsem proxy używanym przez pasywne proxy.
sortfield	string/array	Posortuj wyniki według podanych właściwości. Możliwe wartości: `hostid`, `host` i `status`.
countOutput	boolean	Te parametry, będące wspólne dla wszystkich metod `get`, są szczegółowo opisane na stronie komentarza referencyjnego.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

tablicę obiektów;
liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie wszystkich serwerów proxy

Pobierz wszystkie skonfigurowane serwery proxy i ich interfejsy.

Zapytanie:

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

Odpowiedź:

{  "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 }

Zobacz także

Źródło

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

Documentation