proxy.get

Beschrijving

integer/array proxy.get(object parameters)

De methode maakt het mogelijk om proxy's op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
proxyids	string/array	Retourneer alleen proxy's met de opgegeven ID's.
selectHosts	query	Retourneer een eigenschap hosts met de hosts die worden gecontroleerd door de proxy.
selectInterface	query	Retourneer een eigenschap interface met de proxy-interface die wordt gebruikt door een passieve proxy.
sortfield	string/array	Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: `hostid`, `host` en `status`.
countOutput	boolean	Deze parameters gelden voor alle `get`-methoden en worden in detail beschreven in de referentiecommentaar.
editable	booleaans
excludeSearch	boolean
filter	object
limiet	geheel getal
uitvoer	query
preservekeys	boolean
zoeken	object
searchByAny	boolean
searchWildcardsIngeschakeld	boolean
sortorde	string/array
startZoeken	booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Alle proxy's ophalen

Haal alle geconfigureerde proxy's en hun interfaces op.

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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

Documentation