Documentation
Table of Contents
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
countOutputzosta? 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
?°ù¨®»å?´Ç
CProxy::get() w ui/include/classes/api/services/CProxy.php.