proxygroup.get

Beschreibung

integer/array proxygroup.get(object parameters)

Mit dieser Methode können Sie Proxy-Gruppen entsprechend den angegebenen Parametern abrufen.

Diese Methode steht Benutzern jeden Typs zur Verfügung. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen. Es werden nur Proxy-Gruppen zurückgegeben, die durch die Proxy access list der Benutzergruppen des Benutzers zugelassen sind.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
proxy_groupids ID/array Gibt nur Proxy-Gruppen mit den angegebenen IDs zurück.
proxyids ID/array Gibt nur Proxy-Gruppen zurück, die die angegebenen Proxys enthalten.
selectProxies query Gibt eine proxies-Eigenschaft mit den Proxys zurück, die zur Proxy-Gruppe gehören.

Unterstützt count.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: proxy_groupid, name.
countOutput boolean Diese Parameter sind in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder:

  • eine Reihe von Objekten zurück;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde zurück.

Beispiele

Alle Proxy-Gruppen abrufen

Rufen Sie alle konfigurierten Proxy-Gruppen mit Proxys ab.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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