This is a translation of the original English documentation page. Help us make it better.

proxy.get

Beschrijving

integer/array proxy.get(object parameters)

Met deze methode kunt u proxies ophalen op basis van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
proxyids string/array Geef alleen proxies terug met de opgegeven IDs.
selectHosts query Geef een hosts eigenschap terug met de hosts die worden bewaakt door de proxy.
selectInterface query Geef een interface eigenschap terug met de interface van de proxy die wordt gebruikt door een passieve proxy.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: hostid, host, status.
countOutput boolean Deze parameters die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Teruggegeven waarden

(integer/array) Geeft ofwel:

  • een array van objecten;
  • het aantal opgehaalde objecten, als de parameter countOutput is gebruikt.

Voorbeelden

Alle proxies ophalen

Haal alle geconfigureerde proxies op samen met hun interfaces.

Aanvraag:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "host": "Actieve proxy",
                   "status": "5",
                   "description": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "proxy_address": "",
                   "auto_compress": "0",
                   "version": "60400",
                   "compatibility": "1",
                   "proxyid": "30091",
                   "interface": []
               },
               {
                   "host": "Passieve proxy",
                   "status": "6",
                   "description": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "proxy_address": "",
                   "auto_compress": "0",
                   "lastaccess": "0",
                   "version": "0",
                   "compatibility": "0",
                   "proxyid": "30092",
                   "interface": {
                       "interfaceid": "30109",
                       "hostid": "30092",
                       "main": "1",
                       "type": "0",
                       "useip": "1",
                       "ip": "127.0.0.1",
                       "dns": "",
                       "port": "10051",
                       "available": "0",
                       "error": "",
                       "errors_from": "0",
                       "disable_until": "0",
                       "details": []
                   }
               }
           ],
           "id": 1
       }

Zie ook

Bron

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