proxy.update

Beschreibung

object proxy.update(object/array proxies)

Mit dieser Methode können vorhandene Proxys aktualisiert werden.

Diese Methode ist nur für den Benutzertyp Super admin verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object/array) Zu aktualisierende Proxy-Eigenschaften.

Die Eigenschaft proxyid muss für jeden Proxy definiert sein, alle anderen Eigenschaften sind optional. Nur die übergebenen Eigenschaften werden aktualisiert, alle anderen bleiben unverändert.

Zusätzlich zu den Standard-Proxy-Eigenschaften akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
hosts array Hosts, die vom Proxy überwacht werden sollen.
Wenn ein Host bereits von einem anderen Proxy überwacht wird, wird er dem aktuellen Proxy neu zugewiesen.

Für die Hosts darf nur die Eigenschaft hostid definiert sein.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der aktualisierten Proxys unter der Eigenschaft proxyids enthält.

Beispiele

Von einem Proxy überwachte Hosts ändern

Aktualisieren Sie den Proxy, damit er die beiden angegebenen Hosts überwacht.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "hosts": [
            {
                "hostid": "10294"
            },
            {
                "hostid": "10295"
            }
        ]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10293"
        ]
    },
    "id": 1
}

Proxy-Status ändern

Ändern Sie den Proxy in einen aktiven Proxy und benennen Sie ihn in „Active proxy“ um.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "name": "Active proxy",
        "operating_mode": "0"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10293"
        ]
    },
    "id": 1
}

Einen Proxy zu einer Proxy-Gruppe hinzufügen

Aktualisieren Sie den Proxy mit der ID „5“ und fügen Sie ihn der Proxy-Gruppe mit der ID „1“ hinzu.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "proxyid": "5",
        "proxy_groupid": "1",
        "local_address": "127.0.0.1"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "5"
        ]
    },
    "id": 1
}

Siehe auch

Quelle

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